Harmony
  1. Harmony
  2. HARMONY-3263

[drlvm][doc]scarce comments in vmcore external interface headers (VM_JIT and VM_EM bundle)

    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 VM_JIT and VM_EM interfaces so that Doxygen parses them correctly.

        VM_JIT
        jit_import.h
        -Add brief description [@file]
        -Add detailed description (if necessary)
        -Can use \ingroup, \defgroup to get rid of such phrases, as "begin method-related functions", "end method-related functions: bytecodes" etc.

        jit_runtime_support.h
        -Add brief description [@file]
        -Add detailed description (if necessary)
        -Document functions, enums, typedefs (where the description is missing)
        -Use @note for note text, but not just NOTE
        -Group related functionalities together
        [Object creation routines; Exception throwing routines; Type access routines; Deprecated routines;etc]
        using \ingroup, \defgroup, \addtogroup [<http://www.stack.nl/~dimitri/doxygen/grouping.html> ]
        -Use @return, @param where necessary

        VM_EM
        vmcore/include/ini.h
        -Add brief description [@file]
        -Add detailed description (if necessary)

        • Document functions
        Show
        Svetlana Konovalova added a comment - Here are suggestions on how to improve code comments of the VM_JIT and VM_EM interfaces so that Doxygen parses them correctly. VM_JIT jit_import.h -Add brief description [@file] -Add detailed description (if necessary) -Can use \ingroup, \defgroup to get rid of such phrases, as "begin method-related functions", "end method-related functions: bytecodes" etc. jit_runtime_support.h -Add brief description [@file] -Add detailed description (if necessary) -Document functions, enums, typedefs (where the description is missing) -Use @note for note text, but not just NOTE -Group related functionalities together [Object creation routines; Exception throwing routines; Type access routines; Deprecated routines;etc] using \ingroup, \defgroup, \addtogroup [<http://www.stack.nl/~dimitri/doxygen/grouping.html> ] -Use @return, @param where necessary VM_EM vmcore/include/ini.h -Add brief description [@file] -Add detailed description (if necessary) Document functions

          People

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

            Dates

            • Created:
              Updated:

              Development