harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Svetlana Konovalova (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HARMONY-3273) [drlvm]scarce comments in vmcore external interface headers (VM_GC and VM_Thread bundle)
Date Thu, 01 Mar 2007 13:15:50 GMT

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

Svetlana Konovalova commented on HARMONY-3273:
----------------------------------------------

Here are suggestions on how to improve code comments of the VM Common interface (VM_GC and
VM_Thread bundle)  so that Doxygen parses them correctly. 

GENERAL NOTE: I do respect the authors of all these headers and I do understand how proud
they are to see their names in the comments! :) But, since it's the open source, I'd like
to ask you to remove the authors' names from the files content. Thanks in advance and sorry
about that!

VM_GC

include/open/vm_gc.h
-Add detailed description (if necessary)
-Document functions (where the description is missing)
- Can we use smth like \ingroup, \defgroup to get rid of
 * *****
 * *
 * *  Routines to support finalization of objects.
 * * 
 * *****
 */

include/slot.h (?)
- Add missing descriptions
-use appropriate formatting
-Use @return, @param where necessary

VM_Thread

include/open/thread_externals.h
-Add detailed description 
-Add brief description [@file]
-Add missing functions descriptions 


> [drlvm]scarce comments in vmcore external interface headers (VM_GC and VM_Thread bundle)
> ----------------------------------------------------------------------------------------
>
>                 Key: HARMONY-3273
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3273
>             Project: Harmony
>          Issue Type: Bug
>          Components: DRLVM
>            Reporter: Svetlana Konovalova
>
>  Many files lack ample and well-formatted comments; need to get easily readable, complete
and useful reference for DRLVM Interface Reference and Java class library reference; the code
commenting BKMs (http://wiki.apache.org/harmony/Code_Commenting) can be useful. Specific suggestions
on improving Doxygen output are below.

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