[jira] Commented: (HARMONY-3274) [drlvm]scarce comments in vmcore external interface headers (JNI and JVMTI bundle)

["Svetlana Konovalova (JIRA)" <ji...@apache.org>]

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

Svetlana Konovalova commented on HARMONY-3274:
----------------------------------------------

Here are suggestions on how to improve code comments of the VM Common interface (JNI and JVMTI 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! 

JNI

include/jni_types.h
-Add detailed description 
-Add brief description [@file]
- Document functions
- use appropriate formatting to make comments VISIBLE
- use \ingroup, \defgroup

include/jni.h 
-Add detailed description 
-Add brief description [@file]
- Document functions

JVMTI

include/jvmti.h
-Add detailed description 
-Add brief description [@file]
- Document functions
-Use appropriate formatting

include/jvmti_types.h 
-Add detailed description 
-Add brief description [@file]
- Document functions
- use \ingroup, \defgroup (if applicable)


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