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-3263) [drlvm]scarce comments in vmcore external interface headers (VM_Jit and VM_EM bundle)
Date Wed, 28 Feb 2007 08:35:05 GMT

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

Svetlana Konovalova commented on HARMONY-3263:
----------------------------------------------

Here are suggestions on how to improve code comments of the VM_JIT and VM_EM interfaces so
that Doxygen parses them correctly. 

VM_JIT
jit_import.h
-Add brief description [@file]
-Add detailed description (if necessary)
-Can use \ingroup, \defgroup to get rid of such phrases, as "begin method-related functions",
 "end method-related functions: bytecodes" etc.

jit_runtime_support.h
-Add brief description [@file]
-Add detailed description (if necessary)
-Document functions, enums, typedefs (where the description is missing)
-Use @note for note text, but not just NOTE
-Group related functionalities together 
[Object creation routines; Exception throwing routines; Type access routines; Deprecated routines;etc]
 using \ingroup, \defgroup, \addtogroup [<http://www.stack.nl/~dimitri/doxygen/grouping.html>
]
-Use @return, @param where necessary 

VM_EM
vmcore/include/ini.h
-Add brief description [@file]
-Add detailed description (if necessary)
- Document functions


> [drlvm]scarce comments in vmcore external interface headers (VM_Jit and VM_EM bundle)
> -------------------------------------------------------------------------------------
>
>                 Key: HARMONY-3263
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3263
>             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