![]() How to use kernel-doc comments in DocBook XML template files ¶ĭocBook XML template files (*.tmpl) are like normal XML files, except that theyĬan contain escape sequences where extracted documentation should be inserted. This is where C files are associated with SGML templates. The older target ‘sgmldocs’ is equivalent to ‘xmldocs’. The targets ‘xmldocs’, ‘psdocs’, ‘pdfdocs’, and ‘htmldocs’ are used to buildĭocBook XML files, PostScript files, PDF files, and html files inĭocumentation/DocBook. This is used to generate dependency information as used by It invokes kernel-doc, giving it the list of functions that are to beĪdditionally it is used to scan the XML template files to locate all the files When aįile is referenced it is searched for symbols exported (EXPORT_SYMBOL), to beĪble to distinguish between internal and external functions. This is a program for converting XML template files into XML files. Place-holders for where the extracted documentation should go. These are XML template files, which are normal XML files with special ![]() This is a perl script that hunts for the block comments and can mark them upĭirectly into reStructuredText, DocBook, man, text, and HTML. Many places in the source tree have extractable documentation in the form ofīlock comments above functions. In kernel-doc notation as: return value, if any, should be described in a dedicated section at the end Must begin on the very next line following the opening brief functionĭescription line, with no intervening blank comment lines. The kernel-doc function comments describe each parameter to the function, in The brief description following the function name may span multiple lines, andĮnds with an description, a blank comment line, or the end of the * * The return value description can also have multiple paragraphs, and should * be placed at the end of the comment block. * * Return: Describe the return value of foobar. * * The longer description may have multiple paragraphs. Begins with an * empty comment line, and may include additional embedded empty * comment lines. * * A longer description, with more discussion of the function function_name() * that might be useful to those using or modifying it. * One can provide multiple line descriptions * for arguments. ![]() ** * function_name() - Brief description of function. In the table-row there is only one markup allowed, The example below shows how to use this markup. :cspan: additional columns ( morecols).:fill-cells: instead of auto-spanning missing cells, insert missing cells.With Option :fill-cells: this behavior canĬhanged from auto span to auto fill, which automatically inserts (empty) auto span rightmost cell of a table row over the missing cells on the right. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |