pike.git / refdoc / keywords.txt

version» Context lines:

pike.git/refdoc/keywords.txt:166:   Groups with: -   Examples:    @example    array a = func();    if (sizeof(a) > MAX) // security check    exit(1);      XML: <example/>   ________________________________________________________________________________    + Keyword: @fixme + Description: Note about something that needs fixing in the manual. + Arguments: - + Children: Text (with markup). + Groups with: - + Examples: +  @fixme +  The return values of this function is not correctly documented. +  + XML: <fixme/> + ________________________________________________________________________________ +    Keyword: @note   Description: Important information about the documented item.   Arguments: -   Children: Text (with markup).   Groups with: -   Examples:    @note    Do not call this function unless you know what you are doing.    No bounds/sanity checking on arguments is performed!   
pike.git/refdoc/keywords.txt:361:    @member int "age"    These two entries in the mapping provide personal data.      XML: `@member float "foo"' =>    <member>    <type><float/></type>    <index>"foo"</index>    </member>   ________________________________________________________________________________    + Keyword: @ol - @endol + Description: Creates an ordered list. + Children: @item + Groups with: - + Examples: @ol +  @item +  Open the door +  @item +  Walk through +  @item +  Close the door +  @endol +  + XML: <ol>...</ol> + ________________________________________________________________________________ +    Keyword: @ref{ ... @}   Description: A reference to a Pike entity. There is also a shortcut for this    keyword, since it is expected to be so common: @[ ... ]   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>   ________________________________________________________________________________
pike.git/refdoc/keywords.txt:412:   ________________________________________________________________________________      Keyword: @tt{ ... @}   Description: Teletype.   Children: Text that will be rendered in teletype.   Examples: Type @tt{rm -rf *@} to erase several days of work.      XML: <tt> ... </tt>   ________________________________________________________________________________    + Keyword: @ul - @endul + Description: Creates an unordered list. + Children: @item + Groups with: - + Examples: @ul +  @item +  2 oz light rum +  @item +  Juice of ½ lime +  @item +  Coca Cola +  @endul +  + XML: <ul>...</ul> + ________________________________________________________________________________ +    Keyword: @xml{ ... @}   Description: XML escape. Inside this tag the characters <>& are not quoted and    this makes it possible to insert raw XML. Note that the usual    rules apply to @ and that @i{...@}-style tags can be used inside.   Children: Text with markup.   Examples: @xml{<b>Bold</b> and @i{italic@}@}      XML: No representation.   ________________________________________________________________________________