pike.git / refdoc / keywords.txt

version» Context lines:

pike.git/refdoc/keywords.txt:144:    Where:    [name] if present, must be the same as the argument to    @class.   Children:   Groups with: -   Examples:    /*! @endclass Reinhold */      _______________________________________________________________________________    + Keyword: @endenum + Description: Leave the enum scope entered by @enum. + Arguments: [name] +  Where: +  [name] if present, must be the same as the argument to +  @enum. + Children: + Groups with: - + Examples: +  /*! @endenum Flags */ +  + _______________________________________________________________________________ +    Keyword: @endmodule   Description: Leave the module scope entered by @module   Arguments: [name]    Where:    [name] if present, must be the same as the argument to    @module.   Children: -   Groups with: -   Examples:    /*! @endmodule Roine */
pike.git/refdoc/keywords.txt:172:    Where:    [name] if present, must be the same as the argument to    @namespace.   Children: -   Groups with: -   Examples:    /*! @endnamespace lfun:: */      _______________________________________________________________________________    + Keyword: @enum + Description: Declare and enter a new scope for an enum. Only in C +  mode. Until an @endenum is found, all declarations will +  be regarded as children of the enum. The only valid +  child declarations are declarations of constants. +  + Arguments: <name> +  Where: +  <name> is a valid Pike identifier. Not the "absolute" +  name with dots. +  + Children: Documentation for the enum, or empty. + Groups with: - + Examples: +  /*! @enum Flags +  *! Some flags controlling behavior. +  */ +  /*! @decl constant FLAG_FLAG = 1 +  */ +  /*! @endenum +  */ +  + _______________________________________________________________________________ +    Keyword: @inherit   Description: Tell which classes are inherited into this class.   Arguments: <name>    Where:    <name> is an "absolute" name with identifiers    separated by dots. It can also be prefixed by    'scope::' where scope is one of the valid scope    modules.   Children: -   Groups with: -
pike.git/refdoc/keywords.txt:647:    @[ ... ]   Children: Text that will be interpreted as a Pike name.   Groups with: -      Examples: My favourite class is @ref{Vanilla.Ice.Cream@}, it    tastes much better than @[Nougat.Glass] or @[`+].      XML: <ref>...</ref>   _______________________________________________________________________________    + Keyword: @rfc{ ... @} + Description: Reference to an RFC and optionally a section or appendix. + Children: RFC number and optionally a colon followed by section number +  or appendix letter. + Groups with: - +  + Examples: +  The @[MIME] module implements @rfc{1521@}. +  +  See @rfc{7540:5.3@} for details about @[ADT.TreeScheduler]. +  +  The list of static headers for HPack is defined in @rfc{7541:A@}. +  + XML: <rfc>...</rfc> + _______________________________________________________________________________ +    Keyword: @section - @endsection   Description: Begin a new section in the text. Sections cannot be nested.   Arguments: <title>    Where:    <title> is any text that is the title of the section.   Children: Text (with markup)   Groups with: -   Examples:    @section One - Introduction    ...