harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ilya Leviev (JIRA)" <j...@apache.org>
Subject [jira] Updated: (HARMONY-3310) [drlvm][doc] interpreter headers should be complemented with code comments
Date Mon, 07 May 2007 14:06:15 GMT

     [ https://issues.apache.org/jira/browse/HARMONY-3310?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Ilya Leviev updated HARMONY-3310:
---------------------------------

    Attachment: 6_interpreter_headers.patch

The main part of the 6_interpreter_headers.patch adds documentation for interpreter internal
header files.
Also it includes some corrections in comments of interpreter external headers.

There are following areas for documentation improvement suggested by Svetlana.

interpreter_imports.h

	Add missing Typedef description (typedef struct ManagedObject ManagedObject)

interpreter_exports.h

	Add missing Typedef description (typedef struct FrameHandle FrameHandle) 
	Add missing [in]/[out] parameter types, for example to: 
            * @param bsp - the pointer to the register 
            * @param reg - the register 
	Ln 264 "jvmtiEnv's" 
Need to add the type of element it is. Is it an option, a variable, or what? And we shouldn't
use plural form for a code name. 
	Ln 324 Returns <code>TRUE</code> if interpreter table. 
It defiantly should be paraphrased. The original version does not make sense. 
	The definition of the group does not include the description of what Open Interfaces include.
Do they include the interface functions defined by the OPEN design? Could we provide the link
or something? 

interp_defs.h

	Add missing Member Data and Define Documentation descriptions



Many thanks to Svetlana for review and suggestions during work with interpreter documentation.

 


> [drlvm][doc] interpreter headers should be complemented with code comments
> --------------------------------------------------------------------------
>
>                 Key: HARMONY-3310
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3310
>             Project: Harmony
>          Issue Type: Improvement
>          Components: DRLVM
>            Reporter: Nadya Morozova
>         Assigned To: Nadya Morozova
>         Attachments: 3_interpreter_headers.patch, 3_interpreter_headers.patch, 6_interpreter_headers.patch,
interp_defs_comments.patch, interpreter_exports_h_comments.patch, interpreter_h_comments.patch,
interpreter_imports_h_comments.patch
>
>
> header files located in drlvm\trunk\vm\interpreter\src have very scarse comments. i suggest
that we improve those.

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