https://jira.whamcloud.com This file is an XML representation of an issue en-us 9.4.14 940014 05-12-2023 https://jira.whamcloud.com/browse/LU-9633 Lustre <p>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.</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">Sample Kernel-doc functional documentation format: /** * foobar() - Brief description of foobar. * @arg: Description of argument of foobar. * * Longer description of foobar. * * Return: Description of <span class="code-keyword">return</span> value of foobar. */ <span class="code-object">int</span> foobar(<span class="code-object">int</span> arg) </pre> </div></div> LU-9633

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

Epic Minor Open Unresolved Arshad Hussain Arshad Hussain Sun, 11 Jun 2017 04:41:19 +0000 Thu, 10 Sep 2020 14:04:47 +0000 Upstream 0 4 <p>Arshad thanks for taking this up. I have not had the cycles to do this.</p> <p>Arshad are you still interested in this work?</p> <p>James, apologies for the delay response. I completely missed your comment until today. Yes, I do have couple of Sphinx related patch's to get started. I should be pushing it very soon.</p> <p>Before we start I pushed the sphinix port to the linux lustre client first. I plan to move the upstream client out of the staging tree so the docs can be tested to see how they turn out.</p> Related LU-12511 Development Epic Colour ghx-label-3 Epic Name Add kernel-doc style comments to All lustre Code. Epic Status Rank 1|hzzepz: Rank (Obsolete) 9223372036854775807