[ Outline ] · Standard · Linear+ Source Documentation is hard to read., Can we optimise it?

[mispunt]

Last weekend I have been working a lot with VCF, and I had a look to the source documentation generated by Doxygen. There were three things that needs some attention.

Because I use the svn version of VCF I have genereted the source docs myself.

[1] When I looked for the method textBoundedBy() in the GraphicsContext class, I hade to use the search because the functions are not listed alphabetical.

[2] When I looked to other methods I didn't see any description.

[3] After give this a thought, this is not a problem, or I don't have any arguments to write down why it is a problem...

I have some suggestion for these "problems"

[1] All the methods should be on alphabeticle order. (except for the Constructer/Destructor which should be at the top I think)

[2] Add a description (easier said than done, because programers like to program and don't like documenting )

[vortic]

Because I use the svn version of VCF I have genereted the source docs myself.

[1] When I looked for the method textBoundedBy() in the GraphicsContext class, I hade to use the search because the functions are not listed alphabetical.

It looks like the Member docs are sorted, just not the Brief dos. This probably just requires a doxy switch setting. I'd check out these switches that appear to be sort-related:

SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO


Make sure SORT_BRIEF_DOCS is set to YES, and see if that sorts it. I guess SORT_MEMBER_DOCS is already YES from the looks of the existing sorting.

I'm not sure what this will do for constructors and destructors.

It would be great to take XML output from doxygen, 'parse' it with an app utilizing XML features of VCF, and output it in a format people like. First, we need to know what format people like. See HERE. Then see if it is possible. This might help reformatting help for VS MSDN help integration.

Cheers

Edit:
Yep, SORT_BRIEF_DOCS = YES does sort brief member doc alphabetically. I used doxygen to update Doxyfile.only to doxy 1.4.7 format, and used default doxy .css style sheet. I like it more than current style.