pike.git / refdoc / xml.txt

version» Context lines:

pike.git/refdoc/xml.txt:361:       function(string, mixed ... : void)       <function>    <argtype><string/></argtype>    <argtype><varargs><mixed/></varargs></argtype>    <returntype><void/></returntype>    </function>      ====================================================================== - f) XML generated from the doc markup + f) Other XML tags   ----------------------------------------------------------------------    -  + p +  Paragraph. +  + i +  Italic. +  + b +  Bold. +  + tt +  Terminal Type. +  + pre +  Preformatted text. +  + code +  Program code. +  + image +  An image object. Contains the original file path to the image. Has the +  optional attributes width, height and file, where file is the path to +  the normalized-filename file. +  + ====================================================================== + g) XML generated from the doc markup + ---------------------------------------------------------------------- +    The documentation for an entity is put in a <doc> element. The <doc> element   is either a child of the element representing the entity (in the case of   <class>, <module>, <enum>, or <modifiers>) or a child of the <docgroup> that   contains the element representing the entity.      The doc markup has two main types of keywords. Those that create a container   and those that create a new subsection within a container, implicitly closing   the previous subsection. Consider e.g.:       //! @mapping
pike.git/refdoc/xml.txt:476:    <member><type><string/></type><index>"zip-code"</index></member>      The translation of keyword->XML is done differently for each keyword. How it   is done can be seen in lib/modules/Tools.pmod/AutoDoc.pmod/DocParser.pmod. Most   keywords just interpret the arguments as a space-separated list, and put their   values in attributes to the element. In some cases (such as @member) though,   some more intricate parsing must be done, and the arguments may be complex   (like Pike types) and are represented as child elements of the element.      ====================================================================== - g) Top level sections of different Pike entities. + h) Top level sections of different Pike entities.   ----------------------------------------------------------------------      In every doc comment there is an implicit "top container", and subsections can   be opened in it. E.g.:       //! A method.    //! @param x    //! The horizontal coordinate.    //! @param y    //! The vertical coordinate.