Anybody here use Doxygen to document their code?

[StormRider]

It can produce output in HTML, RTF, Latex, XML etc.

I'm happy with the HTML output but the RTF output looks hideous. I noticed that it can produce XML output. Is there anyway to use that XML to produce better looking RTF output?

 

[apac]

Yep we use Doxygen, but I think we use the standard RTF. I believe you can change the style sheet in the configuration file.

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!

HTML_STYLESHEET =



Here is our documentation, but it should be pretty standard so I assume you've seen others like it before.

 

[kamper]

I don't use it but I'm just curious: what do you use it for specifically? Well, obviously apac uses it for c.... others?

The Doxygen home page said it supported java but I don't see why anyone would want to use it for that when there's javadoc.

 

[apac]

Originally posted by: kamper
I don't use it but I'm just curious: what do you use it for specifically? Well, obviously apac uses it for c.... others?

The Doxygen home page said it supported java but I don't see why anyone would want to use it for that when there's javadoc.

I haven't seen it used for anything but c/c++, I'm pretty sure its designed primarily for c-based code. Edit: The comment structure uses /** */ format.

 

[Barnaby W. Füi]

I use it for c and c++: http://incise.org:82/pub/sighdocs/ (just c here)

 

[apac]

Originally posted by: BingBongWongFooey
I use it for c and c++: http://incise.org:82/pub/sighdocs/ (just c here)

After a quick glance at your code, it doesn't look like doxygen is hiding your internals very well 😉.

 

[Barnaby W. Füi]

Originally posted by: apac

Originally posted by: BingBongWongFooey
I use it for c and c++: http://incise.org:82/pub/sighdocs/ (just c here)

After a quick glance at your code, it doesn't look like doxygen is hiding your internals very well 😉.

I like having the implementation source in the docs. If people want to deviate from the api then they can do so at their own risk. We're all adults here. 😉

 

[apac]

Originally posted by: BingBongWongFooey

Originally posted by: apac

Originally posted by: BingBongWongFooey
I use it for c and c++: http://incise.org:82/pub/sighdocs/ (just c here)

After a quick glance at your code, it doesn't look like doxygen is hiding your internals very well 😉.

I like having the implementation source in the docs. If people want to deviate from the api then they can do so at their own risk. We're all adults here. 😉

Oh I agree, I just found this line somewhat ironic, considering they're obviously not hidden hehe.

00029 #ifndef DOXYGEN /* hide internals from doxygen */

 

[Barnaby W. Füi]

Originally posted by: apac

Originally posted by: BingBongWongFooey

Originally posted by: apac

Originally posted by: BingBongWongFooey
I use it for c and c++: http://incise.org:82/pub/sighdocs/ (just c here)

After a quick glance at your code, it doesn't look like doxygen is hiding your internals very well 😉.

I like having the implementation source in the docs. If people want to deviate from the api then they can do so at their own risk. We're all adults here. 😉

Oh I agree, I just found this line somewhat ironic, considering they're obviously not hidden hehe.

00029 #ifndef DOXYGEN /* hide internals from doxygen */

Oh yeah, that. What that does is prevents doxygen from creating documentation for that code. It'll show it in the raw code, but the functions in there aren't in the docs.

 

[apac]

Originally posted by: BingBongWongFooey
Oh yeah, that. What that does is prevents doxygen from creating documentation for that code. It'll show it in the raw code, but the functions in there aren't in the docs.

Ah I see. You know before July of this year we had the source files online too, and somehow we avoided documenting any static variables and functions, but I don't remember how.

 

[Armitage]

Yep, I've used it, but only for HTML. Very nice tool.