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: [classlib] VM interface docs ?
Date Wed, 24 Jan 2007 16:22:31 GMT
let me know if you aren't working on this...

On Jan 24, 2007, at 10:06 AM, Geir Magnusson Jr. wrote:

>
> On Jan 24, 2007, at 8:31 AM, Morozova, Nadezhda wrote:
>
>> Hi,
>> I've got another idea about placing Doxygen docs: have the generated
>> docs as we agreed but also have a starting page with links on the
>> website. We even have this page - see the svn source tree,
>> trunk/vm/doc/DoxygenStart.html.
>> Does anybody mind if I add such a page to our website svn?
>
> I thought that was the idea - we definitely need to have a page w/  
> links to the right spot on the website where you dump the generated  
> pages, so that a user can easily find and navigate.  I think that's  
> perfectly fine. Go for it.
>
> You also might think about creating the "drop into" directory as  
> part of the site, and having a simple page that the *site* creates  
> that sits in that directory, that has information about what is  
> supposed to go there, how a user can generate it, etc.  Have that  
> page be the same name as the "index" page of the generated doxygen  
> stuff.
>
> that way, when you generate the site yourself, you get a complete  
> site w/ information about where to get and how to create the  
> doxygen content.  Then, when you drop the generated stuff in place,  
> you just get the right stuff.
>
> geir
>
>>
>> Cheers,
>> Nadya
>>
>>
>>> -----Original Message-----
>>> From: Geir Magnusson Jr. [mailto:geir@pobox.com]
>>> Sent: Tuesday, January 23, 2007 10:51 PM
>>> To: dev@harmony.apache.org
>>> Subject: Re: [classlib] VM interface docs ?
>>>
>>>
>>> On Jan 23, 2007, at 2:44 PM, Morozova, Nadezhda wrote:
>>>
>>>> Geir,
>>>>> I wasn't thinking dropping them in SVN, but rather just  
>>>>> dropping the
>>>>> docs into minotaur.
>>>> I like this approach. I'll regenerate the Doxygen docs for DRLVM
>>>> inter-component interfaces and post them there, ok?
>>>> Do I understand correctly that you sftp to minotaur, put the
>>>> archive to
>>>> /www/harmony.apache.org/subcomponents/drlvm|classlib/doxygen and
>>>> unzip?
>>>
>>> Pretty much. I use scp, and have no clue where it should drop, but
>>> yes :)
>>>>
>>>>
>>>> After the docs are there, We can scan the website for actual and
>>>> potential references to classlib and DRLVM Doxygen docs and fix  
>>>> these
>>>> with new links. What do you say?
>>>
>>> yep
>>>
>>>>
>>>> Cheers,
>>>> Nadya
>>>>
>>>>
>>>>> -----Original Message-----
>>>>> From: Geir Magnusson Jr. [mailto:geir@pobox.com]
>>>>> Sent: Tuesday, January 23, 2007 10:37 PM
>>>>> To: dev@harmony.apache.org
>>>>> Subject: Re: [classlib] VM interface docs ?
>>>>>
>>>>>
>>>>> On Jan 23, 2007, at 10:30 AM, Tim Ellison wrote:
>>>>>
>>>>>> Geir Magnusson Jr. wrote:
>>>>>>> On Jan 22, 2007, at 6:33 AM, Tim Ellison wrote:
>>>>>>>
>>>>>>>> Yang Paulex wrote:
>>>>>>>>> For windows, you can download or browse it on my personal
site
>>>>>>>>> [1]. Or
>>>>>>>>> you
>>>>>>>>> can create it by "ant doxygen-natives" and "ant doxygen-
>>>>>>>>> kernel" at
>>>>>>>>> <classlib
>>>>>>>>> working copy>/enhanced/doc directory, supposing you
have  
>>>>>>>>> doxygen
>>>>>>>>> installed.
>>>>>>>>>
>>>>>>>>> [1] http://people.apache.org/~pyang/harmonydoc/windows/
>>>>>>>>
>>>>>>>> Can we get these linked from, or preferably 'moved to', the
>>>> website?
>>>>>>>
>>>>>>> yes please.  Just manually make a directory
>>>>>>
>>>>>> Where are you thinking?  directly in the in the site/docs tree?
>>>>>
>>>>> I wasn't thinking dropping them in SVN, but rather just  
>>>>> dropping the
>>>>> docs into minotaur.  It means that in the event of a minotaur  
>>>>> crash
>>>>> and disk loss, that material would have to be manually restored.
>>>>>
>>>>> I've done the same thing w/ javadoc in the past on the theory that
>> it
>>>>> was of secondary importance and easy to regenerate.
>>>>>
>>>>> geir
>


Mime
View raw message