Uploaded image for project: 'Lustre'
  1. Lustre
  2. LU-9633

Add kernel-doc style comments to All lustre Code describing function & parameters.

Details

    • Epic
    • Resolution: Unresolved
    • Minor
    • Upstream
    • None
    • Add kernel-doc style comments to All lustre Code.
    • 9223372036854775807

    Description

      Presently not all of lustre code is covered with structured documentation or kernel-doc style comments describing functions and parameters or types. This EPIC/Story/Bug aims to add these remaining coverage. Once this is done, it can then be used to create a documentation as docbook or more latest sphinx format.

      Sample Kernel-doc functional documentation format:
      /**
       * foobar() - Brief description of foobar.
       * @arg: Description of argument of foobar.
       *
       * Longer description of foobar.
       *
       * Return: Description of return value of foobar.
       */
      int foobar(int arg)
      

      Attachments

        Issue Links

          Activity

            [LU-9633] Add kernel-doc style comments to All lustre Code describing function & parameters.
            adilger Andreas Dilger made changes -
            Link New: This issue is related to LU-1892 [ LU-1892 ]
            arshad512 Arshad Hussain made changes -
            Attachment New: 9633.sh [ 58163 ]
            arshad512 Arshad Hussain made changes -
            Labels New: dwg
            simmonsja James A Simmons made changes -
            Fix Version/s New: Upstream [ 12991 ]
            simmonsja James A Simmons made changes -
            Link Original: This issue is related to LU-9679 [ LU-9679 ]
            simmonsja James A Simmons made changes -
            Link New: This issue is related to LU-12511 [ LU-12511 ]
            simmonsja James A Simmons made changes -
            Link Original: This issue is related to LU-6215 [ LU-6215 ]
            simmonsja James A Simmons made changes -
            Link New: This issue is related to LU-9679 [ LU-9679 ]
            simmonsja James A Simmons made changes -
            Link New: This issue is related to LU-6215 [ LU-6215 ]
            arshad512 Arshad Hussain made changes -
            Epic Child New: LU-9653 [ 46642 ]

            People

              arshad512 Arshad Hussain
              arshad512 Arshad Hussain
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated: