Harmony
  1. Harmony
  2. HARMONY-3275

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

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Major Major
    • 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 Execution 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/em.h
        -Add detailed description (if necessary)

        • Add missing functions descriptions

        include/open/em_vm.h

        • Add missing typedef description
        • Use appropriate formatting: replace
          /// The runtime name of EM_VM interface.
          With
          /**
        • The runtime name of EM_VM interface.
          */
          etc

        include/open/em_profile_access.h
        -Add detailed description
        -Add brief description [@file]

        • Use \ingroup, \defgroup to get rid of such notes, as
          //EDGE profiler interface or // Value profiler interface
          -Use appropriate formatting (due to incorrect formatting certain desctiption is invisible)
        Show
        Svetlana Konovalova added a comment - Here are suggestions on how to improve code comments of the Execution 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/em.h -Add detailed description (if necessary) Add missing functions descriptions include/open/em_vm.h Add missing typedef description Use appropriate formatting: replace /// The runtime name of EM_VM interface. With /** The runtime name of EM_VM interface. */ etc include/open/em_profile_access.h -Add detailed description -Add brief description [@file] Use \ingroup, \defgroup to get rid of such notes, as //EDGE profiler interface or // Value profiler interface -Use appropriate formatting (due to incorrect formatting certain desctiption is invisible)

          People

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

            Dates

            • Created:
              Updated:

              Development