1

I am adding doxygen comments to a group of c source files, and getting an error in the documentation when the following definitions are parsed.

////////////////////////////////////////////////////////////////////////
//!@brief Checks if the system is ready to insert a given field and compiles a removal list.
//!@param[in] inField - pointer to the field being inserted.
//!@return true, if the system is ready to insert the field
//!@note
//! <pre>
//! Removal list: a list of fields overlapped by the incoming field.
//! A fields insert will not be allowed to enter the display frame if:
//!     1. The insert is a standard field and it overlaps fixed content.
//!     2. The insert is not using the immediate replace option and the field it overlaps has not finished its effects.
//! </pre>
/////////////////////////////////////////////////////////////////////
static bool
CheckInsertReady( pField inField )
{
    // process ...

    return( allReady );
}

/////////////////////////////////////////////////////////////////////
//!@brief Used to access a sequence structure.
//!@param[in] seq - sequence ID
//!@return pointer to the structure or NULL if validation fails.
/////////////////////////////////////////////////////////////////////
public pSeq
GetSeq( ulong seq )
{
    // process ...
    return( NULL );
}

enter image description here

Some warnings:

enter image description here

Can anyone suggest any possible issues?

IDE:

Eclipse IDE for C/C++ Developers

Version: Neon.3 Release (4.6.3)

Build id: 20170314-1500

10SecTom
  • 2,484
  • 4
  • 22
  • 26
  • It seems to be more of an IDE problem than a problem with Doxygen itself? If so, then what is your IDE? – Some programmer dude Apr 05 '18 at 12:16
  • @Someprogrammerdude I added information on the IDE to the question. – 10SecTom Apr 05 '18 at 12:19
  • When you run doxygen outside the IDE what does doxygen report. Btw. which version of doxygen are you using? Did you rename the field to inField and not rerun doxygen? – albert Apr 05 '18 at 12:31
  • I haven't tried running Doxygen outside of the IDE yet (will give it a go). No renaming, but there are many routines with the parameter 'field'. – 10SecTom Apr 05 '18 at 13:03
  • The version is 1.8.14 and I get the same issue running via Doxygen wizard. – 10SecTom Apr 05 '18 at 13:08
  • This is strange, does it give a filename? Is there another file that defines the same routine (checkInsertReady) ? – albert Apr 05 '18 at 13:12
  • This looks like a Eclipse problem. Probably it's a variant of this question: https://stackoverflow.com/questions/10041453 If Eclipse thinks that there is (was?) a parameter `field` then the Eclipse cache probably need an update. – harper Apr 05 '18 at 13:16
  • Cheers for the help lads - looking for possible issues with declarations in the c source. – 10SecTom Apr 05 '18 at 13:56
  • @albert there shouldn't be, but having a look at the build logs. – 10SecTom Apr 05 '18 at 13:56
  • @harper I will have a look at the question now and see. – 10SecTom Apr 05 '18 at 13:57
  • I managed to get the document to build the section in the question correctly, but I haven't figured out the cause of the warning above (I have multiple cases with similar issues). The main error was code related. – 10SecTom Apr 05 '18 at 15:06
  • I found a few typos that seem to tidy up many of the issues. Things like unknown tags, errors closing 
     tag, and unknown escape codes. The unknown cases were comments where < and > were used and not escaped.
     – 10SecTom Apr 05 '18 at 15:09

0 Answers0