The information on these pages may be out of date, or may refer to
resources that have moved or have been made read-only.
For more information please refer to the Apache Attic
This is a landing page for Doxygen source code reference generated automatically from interface headers. Each link should lead to a documentation bundle generated from a component-related set of header files. The purpose of these documents is to provide a complete reference of available code in DRLVM interfaces. Because the code base is being actively developed, not all interfaces are well-documented at this point, so that you can find some interfaces not documented. Everyone's welcome to contribute to this initiative.
The documentation bundles were generated automatically and posted on the site server. You can regenerate the docs from your source files locally, as described in section Regenerating the Reference.
This is a list of links to generated source code documentation bundles.
You can locally regenerate reference materials analogous to those posted on the website. This can be especially useful when writing comments to your code: parsing the newly added comments with Doxygen is an ideal test. To avoid parsing the whole source tree, you can adjust the list of files to include into a specific documentation bundle or configure Doxygen to produce a different output, see section Advanced Tasks.
Follow these instructions to regenerate the Doxygen reference documentation locally:
svn update to make sure you have the latest version of doc-generation support files.
trunk/drlvm/vm/doc and run:
That's it! You should get the Doxygen docs in a set of subdirectories in
DoxygenStart.html file as your starting point.
Generation of Doxygen reference is adjusted by the following files located in
create targets into
ant deletes all previously generated content (if any) and creates new directories for each bundle and places documentation there in the
html subfolder. That location also contains the
log.txt file with the list of errors and warnings produced by Doxygen. Use the log to track progress with commenting.
vm.cfg now depends on the
css and other support files located in the classlib trunk. To parse DRLVM sources with Doxygen, you also need to have class library sources checked out.