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: [doc] No Doxygen reference for code :(
Date Mon, 27 Nov 2006 21:07:33 GMT


Paulex Yang wrote:
> Well, it's time to pick up this old thread again, I just modified the 
> doxygen config files to show the svn revision number and creation time 
> on the doxygen generated API documents at r479710, now the issue is I 
> don't know how to put these generated documents to the website, because 
> the files generated by doxygen is already in html format, should I add 
> these files to standard/site/docs/<some directory> directly, or any 
> other tricks if I put them to standard/site/xdocs and wish them can be 
> copied to corresponding directory in docs by some script magically?

I think that xdocs is going overboard.

Can you place a zip of this stuff on your home dir at the ASF :

   ~<apacheid>/public_html

so we can see?

(or tell us how to generate...)

geir

> 
> Morozova, Nadezhda wrote:
>> +1
>>
>> Thank you, Nadya Morozova
>>  
>>
>> -----Original Message-----
>> From: Paulex Yang [mailto:paulex.yang@gmail.com] Sent: Wednesday, 
>> November 01, 2006 7:55 PM
>> To: harmony-dev@incubator.apache.org
>> Subject: Re: [doc] No Doxygen reference for code :(
>>
>> Alexey Petrenko wrote:
>>  
>>> I think that we can place the docs here:
>>>
>>>     
>> http://incubator.apache.org/harmony/subcomponents/classlibrary/index.htm
>> l
>> Yes, that's one of my candidate, another one is here: 
>> standard/site/docs/documentation/documentation.html, because I think 
>> it is also a reasonable idea for the user to go for "documentation" if 
>> you wanna some API explanation. How about we put the API document in 
>> each subcomponents(classlib/drlvm/jchevm), but also add their link in 
>> documentation/documentation.html?
>>  
>>> 2006/11/1, Paulex Yang <paulex.yang@gmail.com>:
>>>    
>>>> Morozova, Nadezhda wrote:
>>>>      
>>>>> Hi everyone,
>>>>>
>>>>> I've noticed that there's no API reference documentation for
>>>>>         
>> Harmony
>>  
>>>>> code - generated by Doxygen/Javadoc.  I guess many will agree that
>>>>> having API reference is very useful and convenient.
>>>>>
>>>>>
>>>>>
>>>>> This issue was discussed a while ago [1] for kernel classes and vmi
>>>>> interface in classlib. We agreed to store the Doxygen docs on the
>>>>> website by generating them manually from code and placing there. It
>>>>> seems that the old version of the docs was removed from SVN but
>>>>>         
>> never
>>  
>>>>> made its way to the website, so it's just NOWHERE now :-(. Let's 
>>>>>         
>>>> fix it!
>>>>      
>>>>> AFAIU, we want to have the following:
>>>>>
>>>>> 1.    Ability to generate docs locally from source code as part of
>>>>> build - need to change existing build files or write new ones.
>>>>> 2.    Ability to see docs on the website - manually copy a local
>>>>> bundle of docs to the website and add a link. Geir has been         
>>>> planning to
>>>>      
>>>>> include the website into the next snapshot; supplying ready
>>>>>         
>> reference
>>  
>>>>> with it seem nice.
>>>>>
>>>>> Volunteers?
>>>>>         I can work on item 2 for sure to get a nice config file and 
>>>>> patch
>>>>>         
>> the
>>  
>>>>> website to link to our new Doxygen API. Item 1 -fixing the build - 
>>>>>         
>>>> might
>>>>      
>>>>> be more extravagant, so your aid's welcome ;)
>>>>>
>>>>>         
>>>> It is me that removed the original document in classlib/trunk/doc as
>>>>       
>> we
>>  
>>>> discussed before, so seems it should be my responsibility to make the
>>>> work complete:). Sorry for delaying so long. But I still have no
>>>>       
>> strong
>>  
>>>> feelings where to put them in standard/site, any suggestions?
>>>>
>>>> You can create all the API document by run "ant" in
>>>>       
>> classlib/trunk/doc,
>>  
>>>> you can get all document created, assuming Doxygen is installed. If
>>>>       
>> you
>>  
>>>> kindly provide the patch, I will look at it and merge it into SVN.
>>>>      
>>>>> [1] mail thread
>>>>>
>>>>>         
>> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200609.mb
>>  
>>>>> ox/%3c591B455B-186D-43B4-8F9D-D5A0EA52A38D@pobox.com%3e
>>>>>
>>>>>
>>>>>
>>>>> Thanks,
>>>>>
>>>>> Nadya Morozova
>>>>>
>>>>>
>>>>>
>>>>>         
>>>> -- 
>>>> Paulex Yang
>>>> China Software Development Lab
>>>> IBM
>>>>
>>>>
>>>>
>>>>       
>>
>>
>>   
> 
> 

Mime
View raw message