Hi everyone, I have posted several tips/suggestions [1] about writing nice code comments in source header files for generating readable Doxygen reference materials [2]. These guidelines are to define some ground formatting and stylistic rules that would be good to follow when adding comments to code. Your feedback is most welcome because together we can find the best solutions.
The current reference documentation is often incomplete, out-of-date and/or not formatted correctly, which greatly decreases its usefulness. Volunteers are very welcome to supply patches with more commented code. The BKMs, samples and quoted bugs are mostly based on DRLVM materials, so classlib input is also welcomed. You can get involved in one of the following areas or open new JIRAs with your own suggestions/fixes: [3] improving formatting of code comments so that Doxygen parses them correctly [4] enabling creation of structurally meaningful doc bundles and adding intros (mainpage content) to each bundle [5] beautifying Doxygen output [6] monitoring quality and quantity of available Doxygen documentation Thanks, Nadya Morozova [1] http://wiki.apache.org/harmony/Code_Commenting [2] http://harmony.apache.org/subcomponents/drlvm/DoxygenStart.html [3] https://issues.apache.org/jira/browse/HARMONY-2802 [4] https://issues.apache.org/jira/browse/HARMONY-2814 [5] http://wiki.apache.org/harmony/Doxygen_Docs_Look%26Feel_Improvements [6] http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
