[jira] Updated: (HARMONY-3284) [drlvm][doc] scarce comments in OS portability layer external interface headers

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

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

Svetlana Konovalova updated HARMONY-3284:
-----------------------------------------

    Attachment: 2include_headers.patch

2include_headers.patch corrects grammar and fixes formatting in include/open/compmgr.h  and include/component_manager.h 

Here are suggestions on further improvement:

include/open/compmgr.h  
- Define parameters as [in]/[out]
- Add member data documentation descriptions
-  not sure it should be this way:
        "instance - a handle of an instance to free" 
         Maybe <code>FREE</code>, or what?

component_manager.h 
- add brief/detailed descriptions
- define parameters as [in]/[out]

 Would be great if someone could take care of the aforementioned files.

Thanks in advance,
Sveta

 


> [drlvm][doc] scarce comments in OS portability layer external interface headers
> -------------------------------------------------------------------------------
>
>                 Key: HARMONY-3284
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3284
>             Project: Harmony
>          Issue Type: Bug
>          Components: DRLVM
>            Reporter: Svetlana Konovalova
>         Attachments: 2include_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.