harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gregory Shimansky (JIRA)" <j...@apache.org>
Subject [jira] Resolved: (HARMONY-3274) [drlvm][doc]scarce comments in vmcore external interface headers (JNI and JVMTI bundle)
Date Thu, 29 Mar 2007 15:41:25 GMT

     [ 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.

View raw message