We help IT Professionals succeed at work.

We've partnered with Certified Experts, Carl Webster and Richard Faulkner, to bring you two Citrix podcasts. Learn about 2020 trends and get answers to your biggest Citrix questions!Listen Now

x

Doxygen documentation

bass20
bass20 asked
on
Medium Priority
182 Views
Last Modified: 2010-04-15
Hello,

I'm trying to go for a quick start with Doxygen and I've ran into a problem. I documented the code as they recommended but too few documentation is being generated; for example, in this .c file only the struct is documented:

/*! \brief This is a .c file
 *
 */

#include <stdio.h>

//! This is a struct
struct threadArgs{
         //! This is member p
        t_pedido *p;
        //! This is member r
        t_resposta r;
};

/*! \brief This is a function
 *
 *  \param *targs a parameter
 */
void *myFunction(struct threadArgs *targs){ ... }


From the above code, the only thing that gets documented is the struct (in the data structures section). The "This is a .c file" comment doesn't get documented nor do the functions. In the File List section, only the .h files show up :| Any hints?

Thanks in advance! :)

Comment
Watch Question

fridomCEO/Programmer
CERTIFIED EXPERT

Commented:
have you generated a doxyfile? Have you checked the options there?

Regards
Friedrich

Author

Commented:
Yes, I have. Doxygen generates documentation, it doesn't generate it like I need it to. I tried using yes and no for the OPTIMIZE_OUTPUT_FOR_C file, but the output is essentialy the same.
fridomCEO/Programmer
CERTIFIED EXPERT

Commented:
Well I would check all the options and their documentation. with high likeliness the problem can be found there.

Regards
Friedrich

Author

Commented:
Not quite. The problem was rather simple, I was forgetting the \file structural switch on the header of the C file. If anyone ever runs into this problem, just comment the file's "header" like:

/*! \file myFile.c
 *  \brief This is a .c file
 */
Commented:
Closed, 50 points refunded.
GranMod
The Experts Exchange
Community Support Moderator of all Ages

Not the solution you were looking for? Getting a personalized solution is easy.

Ask the Experts
Access more of Experts Exchange with a free account
Thanks for using Experts Exchange.

Create a free account to continue.

Limited access with a free account allows you to:

  • View three pieces of content (articles, solutions, posts, and videos)
  • Ask the experts questions (counted toward content limit)
  • Customize your dashboard and profile

*This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

OR

Please enter a first name

Please enter a last name

8+ characters (letters, numbers, and a symbol)

By clicking, you agree to the Terms of Use and Privacy Policy.