harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andrey Yakushev" <andrey.yakus...@gmail.com>
Subject Re: [drlvm][doc] doxygen documentation
Date Wed, 20 Dec 2006 11:15:21 GMT
I suggest several improvements for these config files. They are placed
in the patch in HARMONY-2814.

This patch adds mainpage for doxygen generated interfaces documentation.
Mainpage source is placed at vm/include/open/mainpage.html file

Patch also contains several minor documentation improvements:
- README.html for vm/doc with easy navigation to all doxygen generated bundles
- New generated bundle combining all existed bundles together
- Splitting erroneously combined port and tests bundles
- Correcting the default classlib placement from
${basedir}/../../../../classlib/trunk to

Any comments or suggestions are welcome.


On 12/19/06, Morozova, Nadezhda <nadezhda.morozova@intel.com> wrote:
> Hi all,
> I've committed new config files to drlvm/trunk/vm/doc so that you can
> build Doxygen documentation for drlvm interfaces locally. These script
> files are taken from HARMONY-2024. Suggestions/feedback welcome.
> Generated versions are stored at http://people.apache.org/~nadinem/ -
> intf_doc, drlvm_intf_doc, and vmcore_doc. I'll regenerate once in while
> to reflect recent functionality changes. Note that the files have the
> nice starting page with the table (also taken from HARMONY-2024), but
> you won't have it if you run Doxygen over your sources. To get the
> starting page locally, apply the patch for vm.h to your source files.
> Statistics on the quality/quantity of the Doxygen documentation is
> collected on the Wiki page,
> http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
> Cheers Nadya

View raw message