[LU-9633] Add kernel-doc style comments to All lustre Code describing function & parameters.

• Type: Epic
• Resolution: Unresolved
• Priority: Minor
• Fix Version/s: Upstream
• Labels: dwg
• Epic Name: Add kernel-doc style comments to All lustre Code.
• Assignee: Arshad Hussain
• Reporter: Arshad Hussain

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)

Issue Links

• is related to: LU-12511 Prepare lustre for adoption into the linux kernel
• is related to: LU-19844 Add kernel-doc style comments for subsystem osd-zfs
• is related to: LU-19407 Add kernel-doc style comments for subsystem obdecho
• is related to: LU-1892 In-tree documentation improvements
• is related to: LU-930 Update or improvement to a Lustre man page, documentation, or messages
• is related to: LU-19845 Add kernel-doc style comments for subsystem osd-ldiskfs