Any Doxygen users out there?

[tatteredpotato]

I'm trying to get it setup to do documentation for a C project. I'm rather familiar with both javadoc style and C# XML style comments (both seem to be supported). My problem is when I generate the documentation, I can't seem to find these comments anywhere. The file list only lets me click on the [souce] link that shows the source file with the XML or Javadoc comments stripped out. I'm thinking I need some form of header in each file maybe?

 

[Kirby]

if i remember correctly you need use the @file or \file command.

 

[tatteredpotato]

if i remember correctly you need use the @file or \file command.

Thanks, that was exactly the problem. I was initially going to do the VS XML style comments, but Javadoc style are much easier on an IDE that doesn't know to expand "///" to multiple lines.

 

[Kirby]

Thanks, that was exactly the problem. I was initially going to do the VS XML style comments, but Javadoc style are much easier on an IDE that doesn't know to expand "///" to multiple lines.

Agreed. You can really bang out comments in VS, but the xml style just seems slower if you have to type it all out.

Btw, if you can figure out how to add comments to an inline function with the definition in the header, let me know.

 

[tatteredpotato]

Agreed. You can really bang out comments in VS, but the xml style just seems slower if you have to type it all out.

Btw, if you can figure out how to add comments to an inline function with the definition in the header, let me know.

You mean a function like this (located in foo.h):

inline int max(int a, int b) {
	return a > b ? a : b;
}

The above responds just like a non-inline function when I run doxygen.

Are you declaring it as static? Doxygen skips statics by default afaik.

 

[Kirby]

yup, static. i bet there was an option i missed. oh well, i'm not maintaining it anymore, so someone else can deal with it. 😀