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-3432) [drlvm][doc] starting pages for doxygen docs missing for components
Date Wed, 28 Mar 2007 13:31:25 GMT

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

Nadya Morozova commented on HARMONY-3432:
-----------------------------------------

Andrey,
i've looked at the patch, thanks for doing this. however, i think this is not ready for committing
yet. 

your table lists all the interfaces both exported and imported; would be great if we stuck
to exported only; imported interfaces are those that a component uses from other components,
right? then it'd be logical to list those interfaces with the component that exports them;
otherwise, you end up with links that go nowhere, because you're trying to link to sources
outside the bundle

the table includes some implementation-specific files, such as the ones located in gc_cc and
gc_v4; i hope these can be replaced with implementation-independent headers

the table seems to list all files that are in #include; i'd recommend that we first filter
out that list for truly-exported interfaces and then post the file. 

i'm planning to add a small patch with placeholder text for components; hope this helps creating
future mainpages.

thanks again for the patch, it shows that some of the vmcore components (reflection, verifier,
object layout) are not properly documented. i'd open a bug and urge everyone for updates.

> [drlvm][doc] starting pages for doxygen docs missing for components
> -------------------------------------------------------------------
>
>                 Key: HARMONY-3432
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3432
>             Project: Harmony
>          Issue Type: Improvement
>          Components: DRLVM, Website/Documentation
>            Reporter: Nadya Morozova
>            Priority: Minor
>         Attachments: vmcore_mainpage.patch
>
>
> The Doxygen reference documentation built from VM sources (http://harmony.apache.org/subcomponents/drlvm/DoxygenStart.html)
does not always have the starting page to define what's included there. The only exception
is the external interfaces bundle. 
> We need to write short overview pages and add these to the source tree to enable starting
pages. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message