harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Geir Magnusson Jr." <g...@pobox.com>
Subject Re: [drlvm][doc] doxygen documentation
Date Wed, 27 Dec 2006 01:26:22 GMT

On Dec 19, 2006, at 10:27 AM, Morozova, Nadezhda wrote:

>> -----Original Message-----
>> From: Geir Magnusson Jr. [mailto:geir@pobox.com]
>> Sent: Tuesday, December 19, 2006 6:16 PM
>> To: dev@harmony.apache.org
>> Subject: Re: [drlvm][doc] doxygen documentation
>> Morozova, Nadezhda wrote:

>>> 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.
>> Can we start hanging this on the website somewhere?  That would be
>> useful....
> [Nadya] which ones? There are 3 bundle - the huge dirty one, the
> external interfaces and the one for vmcore. If we decide to post, I
> recommend the external interfaces one.


> I'm also concerned about the place: don't want to store these in site
> svn. Crazy idea: do you think we can store the doc bundle archives  
> as we
> store builds? Like, you can download the code and/or pre-generated
> documentation.

Well, in the past, I've have a similar problem with javadoc - I  
didn't feel it worth putting in the site SVN, so I just generated it,  
scp-ed it to the staging machine, and unzipped the tarball in the  
right spot.

the downside is that in the event of a catastrophic failure, the site  
isn't regenerated just from SVN, but this isn't a critical thing, IMO...


>> geir
>>> 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