harmony-commits mailing list archives

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

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

Andrey Yakushev commented on HARMONY-2814:


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

> 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?

I agree

> I suspect each bundle has its own @mainpage with the table of documented interfaces.
Currently no. Only interfaces and test budles have it. But eventually - yes.

> Will this produce a conflict when building the drlvm bundle from all the individual bundles?
That was the main reason for me to move mainpage from vm.h to a separate file. Now we can
resolve such conflicts by pointing the different files for the different 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? 
Yes. But eventually @file tag should be added in all files, I think.

> 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. 
Ok, I will prepare additional patch for this.

> [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, README.html
> 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