Want to protect your cyber security and still get fast solutions? Ask a secure question today.Go Premium

x
?
Solved

Doxygen documentation

Posted on 2006-03-28
6
Medium Priority
?
159 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! :)

0
Comment
Question by:bass20
  • 2
  • 2
5 Comments
 
LVL 24

Expert Comment

by:fridom
ID: 16317910
have you generated a doxyfile? Have you checked the options there?

Regards
Friedrich
0
 
LVL 1

Author Comment

by:bass20
ID: 16319368
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
 
LVL 24

Expert Comment

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

Regards
Friedrich
0
 
LVL 1

Author Comment

by:bass20
ID: 16319986
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
 

Accepted Solution

by:
GranMod earned 0 total points
ID: 16353442
Closed, 50 points refunded.
GranMod
The Experts Exchange
Community Support Moderator of all Ages
0

Featured Post

Concerto Cloud for Software Providers & ISVs

Can Concerto Cloud Services help you focus on evolving your application offerings, while delivering the best cloud experience to your customers? From DevOps to revenue models and customer support, the answer is yes!

Learn how Concerto can help you.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Summary: This tutorial covers some basics of pointer, pointer arithmetic and function pointer. What is a pointer: A pointer is a variable which holds an address. This address might be address of another variable/address of devices/address of fu…
Examines three attack vectors, specifically, the different types of malware used in malicious attacks, web application attacks, and finally, network based attacks.  Concludes by examining the means of securing and protecting critical systems and inf…
Video by: Grant
The goal of this video is to provide viewers with basic examples to understand and use for-loops in the C programming language.
Video by: Grant
The goal of this video is to provide viewers with basic examples to understand and use nested-loops in the C programming language.
Suggested Courses

572 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question