[jira] Commented: (HARMONY-3277) [drlvm]scarce comments in Thread manager external interface headers

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

    [ https://issues.apache.org/jira/browse/HARMONY-3277?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12476949 ] 

Svetlana Konovalova commented on HARMONY-3277:
----------------------------------------------

Here are suggestions on how to improve code comments of the Thread manager component 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! 

include/open/jthread.h
- Add missing functions descriptions

include/open/ti_thread.h
- Add missing functions descriptions

include/open/hycomp.h
-Add detailed description 
-Add brief description [@file]
- Add missing functions descriptions

include/open/hythread.h
-Add detailed description 
-Add brief description [@file]
- Document functions

include/open/hythread_ext.h
-Add missing functions descriptions
-Use appropriate formatting to make comments VISIBLE

include/open/thread_helpers.h
-Add detailed description 
- Document functions



>  [drlvm]scarce comments in Thread manager external interface headers
> --------------------------------------------------------------------
>
>                 Key: HARMONY-3277
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3277
>             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.