Doxygen does not generate function documentation

Question

I'm trying to use doxygen for the first time.

I'm using it in order document some C library, and structures.

I think to use the correct tags, but the documentation is good only as far the define macros are concerned, but the function tags (\fn) are completely ignored. I attach below an example of one my tagged comment:

`/*!    \file   cab.h`

    \author dan
    \date   20/12/2013
    \brief  cab

`*/
   /*! \def NOT_SPECIFIED`

     \brief Constant value that indicates the not specification of a parameter
  ` */`

   `#define NOT_SPECIFIED 0`

    /*! \fn         cab_create
     \brief     allocates the memory space and resources for the CAB
     \param     c cab to create
     \param     dim_buf size of the data contained in each buffer
     \param     maximum number of buffer
     \param     protocol used to handle priority inversion 
     \param     ceiling value of the ceiling,
     \return    1 if it completes successfully, -1 otherwise
    */`
    int cab_create(cab *c, int dim_buf, int max_buf, int protocol, int ceiling);

Could you please paste your Doxyfile ?

liberforce
– liberforce

2013-12-30 15:38:30 +00:00
Commented Dec 30, 2013 at 15:38 — liberforce
– liberforce, Commented Dec 30, 2013 at 15:38

albert · Accepted Answer · 2018-12-22 15:06:49Z

11

The documentation clearly says that \fn is only required if your comment is not placed immediately before your function declaration.

If your comment block is in front of the function declaration or definition this command can (and to avoid redundancy should) be omitted.

So just remove the whole \fn line, and it should work.

UPDATE:

By the way, \file shouldn't have a filename after it.

If the file name is omitted (i.e. the line after \file is left blank) then the documentation block that contains the \file command will belong to the file it is located in.

If you specify a filename, you'll have to update it manually if the filename changes (and this will happen), and you may forget to do so. Not specifying a filename is easier and will always be up-to-date.

edited Dec 22, 2018 at 15:06

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Dec 30, 2013 at 15:52

liberforce

11.5k43 silver badges49 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Michael Over a year ago

Note: the blank line that should follow \file without a file name can not even have a framing *, it must be completely blank!

Collectives™ on Stack Overflow

Doxygen does not generate function documentation

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related