harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Nadya Morozova (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HARMONY-2814) [drlvm][doc] Mainpage for doxygen generated interfaces documentation
Date Wed, 17 Jan 2007 09:29:27 GMT

    [ https://issues.apache.org/jira/browse/HARMONY-2814?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12465396

Nadya Morozova commented on HARMONY-2814:

Here are some review comments on the suggested fixes. 

Do I understand correctly that your earlier patch for vm.h with starting-page content should
be disregarded?

I like the idea of README.html very much in the vm/doc directory. However, if we add it to
svn as is, the file name might be ambiguous: you get a source bundle with README.html, which
does not contain README content usual for a product and only links to the auto-generated sources,
no other DRLVM documents.
I suggest that we rename your README.html file to something like DoxygenStart.html or APIReference.html.
We can also add an introduction at the start of the page to explain that the links from the
page only work when you have built the Doxygen reference. What do you say?

You additions to the build.xml file with new targets are also useful. I guess we can get rid
of the earlier implementation of drlvm_intf_doc suggested in HARMONY-2024. 
A question on that: your drlvm bundle incorporates all other bundles. I suspect each bundle
has its own @mainpage with the table of documented interfaces. Will this produce a conflict
when building the drlvm bundle from all the individual bundles?

Do you think we can change the vm.cfg file as well to enable EXTRACT_ALL? Otherwise, headers
with no @file tag are not included into the generated doumentation?

Another request: could you please adjust doc.properties file more to be aligned with your
starting page content? the lists of files don't seem to always coincide.

> [drlvm][doc] Mainpage for doxygen generated interfaces documentation
> --------------------------------------------------------------------
>                 Key: HARMONY-2814
>                 URL: https://issues.apache.org/jira/browse/HARMONY-2814
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Website/Documentation
>            Reporter: Andrey Yakushev
>         Assigned To: Nadya Morozova
>         Attachments: Doxygen_intf_mainpage.patch
> Create a main page for doxygen generated interfaces documentation

This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message