Sample doxygen configuration, output for VM interfaces (original) (raw)

Neil Richards neil.richards at ngmr.net
Tue Jul 17 00:58:02 PDT 2012

Hi all, I've uploaded (a webrev of) a sample doxygen configuration file [1], together with the HTML documentation it generates for the (otherwise undocumented) artifacts defined in the header files under jdk/src/share/javavm/export and jdk/src/share/solaris/javavm/export [2].

Whilst the creation of the descriptive documentation for these artifacts is yet to be created, nevertheless I hope that this gives some indication of the structure / nature in which this information would be presented using this approach.

I think the next step will be to make changes to the jdk/make/docs makefile, to pick up settings from there to generate the doxygen configuration file (for the platform currently being built) and then drive its use (in the situation where doxygen is available, naturally).

Please cast your eyes over this stuff - all feedback gratefully received.

Thanks, Neil

[1] http://cr.openjdk.java.net/~ngmr/vmi.00/webrev/ [2] http://cr.openjdk.java.net/~ngmr/vmi.00/html/

-- Unless stated above: IBM email: neil_richards at uk.ibm.com IBM United Kingdom Limited - Registered in England and Wales with number 741598. Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU

More information about the hotspot-dev mailing list