pike.git / refdoc / keywords.txt

version» Context lines:

pike.git/refdoc/keywords.txt:105:    //! @decl float cube(float f)    //! @decl int cube(int i)    //! This is how to document a "polymorph" function.    float|int cube(float|int x) { /* body */ }       //! @decl constant int bitmask    //! A constant which has a public type but private value.      _______________________________________________________________________________    + Keyword: @directive +  + Description: Document a Pike cpp directive. +  +  The rest of the line should be the cpp directive to document. +  + Arguments: [name] +  Where: +  [name] is a cpp directive. + Children: Documentation for the directive. + Groups with: @directive + Note: Typically only used in the cpp:: namespace. + Examples: +  //! @directive #include +  //! +  //! The @tt{#include@} directive is used +  //! to include source code from a different file. +  +  //! @directive #if +  //! @directive #endif +  //! +  //! This is how to document multiple related directives +  //! with one documentation string. +  + _______________________________________________________________________________ +    Keyword: @endclass   Description: Leave the class scope entered by @class.   Arguments: [name]    Where:    [name] if present, must be the same as the argument to    @class.   Children:   Groups with: -   Examples:    /*! @endclass Reinhold */