PDA

View Full Version : ClanLib 0.9 API documentation file format



rombust
09-30-2008, 04:00 PM
I have had a look at tidying up the API header file.

See Attached File

(The output from ReferenceDocs and Doxygen should be the same)

If you want to try it out, ClanLib-0.9/Documentation/Reference/clanlib.doxygen will need modification:

ALWAYS_DETAILED_SEC = YES
MULTILINE_CPP_IS_BRIEF = NO
OPTIMIZE_OUTPUT_FOR_C = YES

:)

Magnus Norddahl
09-30-2008, 08:11 PM
Seems okay to me, although I personally prefer /// over //! for documentation lines.

Did you manually clean it up like this or is it some shell script you are going to run on all the headers?

rombust
09-30-2008, 09:12 PM
I did that manually, but for the rest, I would write a script.

I would also prefer "///", i did not know that doxygen accepted that format.

I'll have a look tomorrow.

rombust
10-01-2008, 02:09 PM
All done

That was difficult and tedious! :wheelchair: