Nadya, All, Suggestion to generate Doxygen from DRLVM code sounds very interesting. I posted a quick solution for Linux to http://issues.apache.org/jira/browse/HARMONY-2024
If you want to have this integrated into build.xml, it would be great to define a correct scope. Could you please give more details what do you expect from the documentation build file? A volunteer can try doing some things important for you first, and then add new features gradually. * Should doxygen build documentation for inter-component interfaces? * What are components? I assume vm, jit, gc are out of the question. Is am execution manager or an interpreter a separate component? * Should doxygen build documentation for each component like vm, jit, interpreter, gc? * Should we put documentation into doc/<component>_doc dirs as class library code does? * Should we use the same formatting as a class library documentation? * We don't need to process .cpp files in DRLVM source tree, do we? * Would each of these choices (inter-component documentation, component interface documentation) be a separate configuration? If yes, should we put each result into the separate directory? * Should doxygen process .java files in DRLVM source tree? * Should the doxygen documentation be integrated with class library documentation? * Do you expect to have inheritance diagrams? Do we need to download Graphviz, or should we expect it preinstalled? * A related question is how many platforms should we support. For example, should I add downloading and compilation of Graphviz for my SuSE Linux? * Should we have different documentation for Windows and Linux? * If something is optional for now, what should be added in future? * Is there any choice for user to affect resulting documentation? With best regards, Alexei Fedotov, Intel Java & XML Engineering >-----Original Message----- >From: Morozova, Nadezhda [mailto:[EMAIL PROTECTED] >Sent: Tuesday, October 31, 2006 4:34 PM >To: harmony-dev@incubator.apache.org >Subject: [doc] No Doxygen reference for code :( > >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 ;) > > > >[1] mail thread >http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200609.m b >ox/[EMAIL PROTECTED] > > > >Thanks, > >Nadya Morozova
