kernel/linux.git/Documentation/doc-guide/kernel-doc.rst, branch v5.19

Documentation: kernel-doc: Promote two chapter headings to page title

2022-04-05T16:00:43+00:00

Promote "Writing kernel-doc comments" heading to page title, in accordance to kernel documentation guidelines. Also promote "Including kernel-doc comments" heading because both headings deserve their own chapters in PDF output. There is no differences in the resulting output except formatting semantics. Cc: Jonathan Corbet Cc: "David S. Miller" Cc: Greg Kroah-Hartman Cc: Tony Nguyen Cc: Vinod Koul Cc: Daniel Borkmann Cc: Mauro Carvalho Chehab Cc: Akira Yokosawa Cc: "Rafael J. Wysocki" Cc: Jens Axboe Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya Signed-off-by: Jonathan Corbet

kernel-doc: Fix example in Nested structs/unions

2020-12-08T17:23:17+00:00

Add missing ';' as well as fixes the indent for the first struct. Signed-off-by: Ben Widawsky Link: https://lore.kernel.org/r/20201207210027.1049346-1-ben.widawsky@intel.com Signed-off-by: Jonathan Corbet

docs: kerneldoc.py: add support for kerneldoc -nosymbol

2020-10-15T05:49:38+00:00

Currently, there's no way to exclude identifiers from a kernel-doc markup. Add support for it. Signed-off-by: Mauro Carvalho Chehab

kernel-doc: Update "cross-referencing from rST" section to use automarkup

2020-09-03T19:50:40+00:00

Update text and examples in the "Cross-referencing from reStructuredText" section to reflect that no additional syntax is needed anymore. Signed-off-by: Nícolas F. R. A. Prado Link: https://lore.kernel.org/r/20200903005747.3900333-3-nfraprado@protonmail.com Signed-off-by: Jonathan Corbet

kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

2019-11-07T20:17:25+00:00

The 'functions' directive is not only for functions, but also works for structs/unions. So the name is misleading. This patch renames it to 'identifiers', which specific the functions/types to be included in documentation. We keep the old name as an alias of the new one before all documentation are updated. Signed-off-by: Changbin Du Signed-off-by: Jonathan Corbet

Doc : doc-guide : Fix a typo

2019-06-28T15:04:14+00:00

fix the disjunction by replacing "of" with "or". Signed-off-by: Sheriff Esseson Signed-off-by: Jonathan Corbet

docs: kernel-doc: typo "if ... if" -> "if ... is"

2019-02-17T22:38:47+00:00

"If no *function* if specified" should instead be "If no *function* is specified". Reported-by: Matthew Wilcox Signed-off-by: Frank Rowand Signed-off-by: Jonathan Corbet

docs: kernel-doc: typo "documentaion"

2019-02-01T22:59:46+00:00

Fix a typo in kernel-doc.rst Signed-off-by: Frank Rowand Signed-off-by: Jonathan Corbet

docs: kernel-doc: update commands to generate man page

2019-02-01T22:59:02+00:00

(1) The command to generate man pages is truncated in the pdf version of the document. Reformat the command into multiple lines to prevent the truncation. (2) Older versions of git do not support all variants of pathspec syntax. Provide commands to generate man pages for various alternate syntax. Signed-off-by: Frank Rowand Signed-off-by: Jonathan Corbet

doc-guide:kernel-doc.rst: Reference to foobar

2018-11-07T22:31:51+00:00

In the Function documentation Section of kernel-doc.rst there is a function_name() function as an example for how to make a comment about a function. But at the end of that example there is a reference to foobar instead of function_name. I think that should rather be function_name, because that was the placeholder the whole example was using. Signed-off-by: Joris Gutjahr Signed-off-by: Jonathan Corbet