Harmony
  1. Harmony
  2. HARMONY-3277

[drlvm][doc] scarce comments in Thread manager external interface headers

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: DRLVM
    • Labels:
      None
    • Estimated Complexity:
      Advanced

      Description

      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.

        Activity

        Hide
        Svetlana Konovalova added a comment -

        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
        Show
        Svetlana Konovalova added a comment - 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

          People

          • Assignee:
            weldon washburn
            Reporter:
            Svetlana Konovalova
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:

              Development