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-3275) [drlvm]scarce comments in Execution manager external interface headers
Date Thu, 01 Mar 2007 13:49:50 GMT

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

Svetlana Konovalova commented on HARMONY-3275:
----------------------------------------------

Here are suggestions on how to improve code comments of the Execution manager component 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! 


include/open/em.h 
-Add detailed description (if necessary)
- Add missing functions descriptions

include/open/em_vm.h 
- Add missing typedef description
- Use appropriate formatting: replace 
/// The runtime name of EM_VM interface.
With 
/**
* The runtime name of EM_VM interface.
*/
etc

include/open/em_profile_access.h
-Add detailed description 
-Add brief description [@file]
- Use \ingroup, \defgroup to get rid of such notes, as 
//EDGE profiler interface or  // Value profiler interface
-Use appropriate formatting (due to incorrect formatting certain desctiption is invisible)


> [drlvm]scarce comments in Execution manager external interface headers
> ----------------------------------------------------------------------
>
>                 Key: HARMONY-3275
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3275
>             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