[jira] Updated: (HARMONY-3274) [drlvm][doc]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:all-tabpanel ]

Svetlana Konovalova updated HARMONY-3274:
-----------------------------------------

    Attachment: JNI_JVMTI_headers.patch

Gregory,
Thanks a lot for the great job you've done! The headers look much better now! 
In my turn, I've corrected grammar, have fixed formatting and broken links.
Feel free to find all the changes in the patch attached.
Would be great if you could help me make these files 100% documented. 

AFAIS, we should resolve the following issues:

jni.h
Add missing Public Member Functions, Public Attributes descriptions.

jni_types.h
Add missing Public Attributes descriptions.

jvmti.h
Add missing Member Data Documentation and Member Function Documentation descriptions.

jvmti_types.h
Add missing Member Data Documentation descriptions.

Don't hesitate to contact me in case you have any questions. 
Thanks in advance!

Sveta



> [drlvm][doc]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
>         Assigned To: Gregory Shimansky
>         Attachments: JNI_JVMTI_headers.patch
>
>
> 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.