• C

Doxygen documentation

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! :)

LVL 1
bass20Asked:
Who is Participating?
I wear a lot of hats...

"The solutions and answers provided on Experts Exchange have been extremely helpful to me over the last few years. I wear a lot of hats - Developer, Database Administrator, Help Desk, etc., so I know a lot of things but not a lot about one thing. Experts Exchange gives me answers from people who do know a lot about one thing, in a easy to use platform." -Todd S.

fridomCEO/ProgrammerCommented:
have you generated a doxyfile? Have you checked the options there?

Regards
Friedrich
0
bass20Author 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.
0
fridomCEO/ProgrammerCommented:
Well I would check all the options and their documentation. with high likeliness the problem can be found there.

Regards
Friedrich
0
bass20Author 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
 */
0
GranModCommented:
Closed, 50 points refunded.
GranMod
The Experts Exchange
Community Support Moderator of all Ages
0

Experts Exchange Solution brought to you by

Your issues matter to us.

Facing a tech roadblock? Get the help and guidance you need from experienced professionals who care. Ask your question anytime, anywhere, with no hassle.

Start your 7-day free trial
It's more than this solution.Get answers and train to solve all your tech problems - anytime, anywhere.Try it for free Edge Out The Competitionfor your dream job with proven skills and certifications.Get started today Stand Outas the employee with proven skills.Start learning today for free Move Your Career Forwardwith certification training in the latest technologies.Start your trial today
C

From novice to tech pro — start learning today.

Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.