You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by "Svetlana Konovalova (JIRA)" <ji...@apache.org> on 2007/03/01 14:19:51 UTC
[jira] Created: (HARMONY-3274) [drlvm]scarce comments in vmcore
external interface headers (JNI and JVMTI bundle)
[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.
[jira] Resolved: (HARMONY-3274) [drlvm][doc]scarce comments in
vmcore external interface headers (JNI and JVMTI bundle)
Posted by "Gregory Shimansky (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HARMONY-3274?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Gregory Shimansky resolved HARMONY-3274.
----------------------------------------
Resolution: Fixed
I've added documentation to jni_types.h, jni.h, jvmti_types.h and jvmti.h files. Mostly comments are brief because JNI and JVMTI interfaces are specified on Sun page, so comments have links to Sun specification.
Somehow doxygen has problems with function pointers typedefs like this:
typedef void (JNICALL * jvmtiStartFunction)
(jvmtiEnv * jvmti_env, JNIEnv * jni_env, void *arg);
Such construction defines a type of pointer to a function with signature (jvmtiEnv * jvmti_env, JNIEnv * jni_env, void *arg). But doxygen parses this incorrectly, and typedefs section contains lots of garbage. This problem should be addressed separately.
Fix applied at 523751.
> [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
>
> 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.
[jira] Updated: (HARMONY-3274) [drlvm][doc]scarce comments in
vmcore external interface headers (JNI and JVMTI bundle)
Posted by "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:
-----------------------------------------
Summary: [drlvm][doc]scarce comments in vmcore external interface headers (JNI and JVMTI bundle) (was: [drlvm]scarce comments in vmcore external interface headers (JNI and JVMTI bundle) )
> [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
>
> 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.
[jira] Reopened: (HARMONY-3274) [drlvm][doc]scarce comments in
vmcore external interface headers (JNI and JVMTI bundle)
Posted by "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 reopened HARMONY-3274:
------------------------------------------
IMHO, we should reopen the issue to add missing function descriptions, check grammar and correct formatting.
> [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
>
> 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.
[jira] Updated: (HARMONY-3274) [drlvm][doc]scarce comments in
vmcore external interface headers (JNI and JVMTI bundle)
Posted by "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.
[jira] Assigned: (HARMONY-3274) [drlvm][doc]scarce comments in
vmcore external interface headers (JNI and JVMTI bundle)
Posted by "Gregory Shimansky (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HARMONY-3274?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Gregory Shimansky reassigned HARMONY-3274:
------------------------------------------
Assignee: Gregory Shimansky
> [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
>
> 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.
[jira] Commented: (HARMONY-3274) [drlvm]scarce comments in vmcore
external interface headers (JNI and JVMTI bundle)
Posted by "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.