harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Morozova, Nadezhda" <nadezhda.moroz...@intel.com>
Subject RE: [doc] What should be improved in DRLVM Doxygen documentation?
Date Tue, 12 Dec 2006 17:21:32 GMT
Resending with fixed link 
[2] http://people.apache.org/~nadinem/drlvm_intf_doc/html.zip archive of
[1]


Cheers, 
Nadya
 

>-----Original Message-----
>From: Morozova, Nadezhda [mailto:nadezhda.morozova@intel.com]
>Sent: Tuesday, December 12, 2006 7:00 PM
>To: dev@harmony.apache.org
>Subject: RE: [doc] What should be improved in DRLVM Doxygen
documentation?
>
>Hi all,
>
>I have uploaded some generated Doxygen doc bundles to my ASF home, see
>list of links below. Much has to be improved both in terms of amount of
>commenting and its quality and appearance of resulting docs, but at
>least we can have a starting point.
>
>My suggestion would be to focus primarily on the external vm
interfaces,
>and I've heard several community members suggest the same.  These are
>published at [3] - online version, [4] archive.
>
>I used HARMONY-2024 [7] scripts and config files with Doxygen 1.4.6. My
>previous 1.4.5 version did not handle the links on the main page. The
>only difference with the configuration suggested in [7] is that I set
>EXTRACT_ALL to YES, to have more files/members included.
>
>Some tips on how to build the same docs using [7] are posted on Wiki
>[8].
>
>My next step would probably be to align the main page for external
>interfaces (the table) with the doc.properties file that sets which
>files to include into the respective target. I have a suspicion that it
>does not run correctly.
>
>Everybody's feedback is welcome.
>
>[1] http://people.apache.org/~nadinem/drlvm_intf_doc/html/ Big bundle
of
>all headers docs in vm trunk
>
>[2] http://people.apache.org/~nadinem/drlvm_intf_doc/drlvm_intf_doc.zip
>archive of [1]
>
>[3] http://people.apache.org/~nadinem/intf_doc/html/
><http://people.apache.org/~nadinem/intf_doc/html/>  vm external
>interfaces docs
>
>[4] http://people.apache.org/~nadinem/intf_doc/html.zip archive of [3]
>
>[5] http://people.apache.org/~nadinem/vmcore_doc/html/ vmcore
interfaces
>docs
>
>[6] http://people.apache.org/~nadinem/vmcore_doc/html.zip archive of
[5]
>
>[7] http://issues.apache.org/jira/browse/HARMONY-2024 JIRA with various
>scripts and patches relevant
>
>[8]
>http://wiki.apache.org/harmony/DRLVM_Documentation_Quality#build_instru
c
>tions

Mime
View raw message