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

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

XMLWordPrintable

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

      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)

        1. 9633.sh
          0.6 kB

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

              Created:
              Updated: