About your question > 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?
I'd say, we can place classlib docs inside standard/site/xdocs/subcomponents/classlib/Doxygen. Do you think we'll need subfolders for classlib modules inside that? > 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. I'd be glad to help. What kind of patch do you need? I can build the docs locally and post a JIRA with the archive. I can also fix the site to have a link to the index.html produced by Doxygen. Is that what you mean? Thank you, Nadya Morozova -----Original Message----- From: Paulex Yang [mailto:[EMAIL PROTECTED] Sent: Wednesday, November 01, 2006 4:33 PM To: harmony-dev@incubator.apache.org Subject: Re: [doc] No Doxygen reference for code :( 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/[EMAIL PROTECTED] > > > > Thanks, > > Nadya Morozova > > > -- Paulex Yang China Software Development Lab IBM
