I have prepared a patch with initial Doxygen main page content. It is attached to HARMONY-2024:
http://issues.apache.org/jira/secure/attachment/12346115/Doxygen_mainpage.patch For quick result evaluation I also tear out generated html file from my workspace and put it at: http://issues.apache.org/jira/secure/attachment/12346118/DRLVM%20Interfaces.htm Will we use it? Thanks, Andrey On 11/20/06, Morozova, Nadezhda <[EMAIL PROTECTED]> wrote:
That's a great start. Yes, if we have such a table as the front page for Doxygen interfaces, it would be great. If you wish, I can prepare the patch with the nice-looking version of it all. Questions: - When building Doxygen, can we have a target for inter-component interfaces and for each component? - if yes, should the files inside the include/ subfolder be built with the component they belong to? - For VM core and jit: any ideas on how to group files further? The current list of files belonging to vm core interfaces is *so* long... - Should we prepare docs for gcv4? Thank you, Nadya Morozova >-----Original Message----- >From: Andrey Yakushev [mailto:[EMAIL PROTECTED] >Sent: Monday, November 20, 2006 3:47 PM >To: [email protected] >Subject: Re: [doc] What should be improved in DRLVM Doxygen documentation? > >In order to understand the mapping between h-files and structure >described in the Developers guide I have tried to prepare some initial >classification. I put draft at >http://wiki.apache.org/harmony/DRLVM_Documentation_Interfaces_Classific atio >n. >Probably such tables could be added to Doxygen doc; of course after >verification and rewriting it in more user friendly manner. > >Is this helpful? > >Thanks, >Andrey > > > >On 11/7/06, Mikhail Fursov <[EMAIL PROTECTED]> wrote: >> On 07 Nov 2006 21:17:45 +0600, Egor Pasko <[EMAIL PROTECTED]> wrote: >> >> > Do we feel that it is time to set responsibilities on documenting >> > vm/include/* ? >> >> >> +1 To start working on intercomponent interfaces. Going to commit a >couple >> of EM interface files with documentation tomorrow. I do not believe that >> someday we will have all component's local code documented (-1 to make >such >> policy for patches), but intercomponent documentation is something we >must >> have (actually we must not only document but clean the code too) >> >> -- >> Mikhail Fursov >> >>
