pike.git / refdoc / keywords.txt

version» Context lines:

pike.git/refdoc/keywords.txt:132:    /*! @module Kenny    *! A module with a Norwegian name. */      ________________________________________________________________________________   ================================================================================       DELIMITER KEYWORDS AT THE TOP LEVEL      ================================================================================    + Keyword: @bugs + Description: Document shortcomings of the current block module/class/function + Arguments: - + Children: Text (with markup). + Groups with: - + Examples: +  @bugs +  Converted images with bigger size than 512x512 pixels will be +  distorted in the corners. +  + XML: <bugs/> + ________________________________________________________________________________ +    Keyword: @deprecated   Description: Documents the fact that the entity is deprecated by one or    several other classes/modules/methods/variables.   Arguments: [item_1 [, item_2 [, item_3 ... ]]]    Where:    [item_n] is an "absolute" name pointing to a Pike entity. It    may use the 'scope::' prefix.   Children: -   Groups with: @deprecated   Examples:
pike.git/refdoc/keywords.txt:253:   Groups with: -   Examples: @array    @elem mixed 0..    All elements are of type mixed.    @endarray      XML: `@array Foo' =>    <array name="Foo">   ________________________________________________________________________________    + Keyword: @b{ ... @} + Description: Bold. + Children: Text that will be rendered in bold. + Examples: You really look @b{bold@}! - You mean @b{bald@}, don't you? +  + XML: <b>...</b> + ________________________________________________________________________________ +  + Keyword: @code{ ... @} + Description: Encapsulates a code block. + Children: Text that will be rendered as program code. + Examples: @code{ +  int fac(int i) { +  if(i<2) return i; +  return i*fac(i-1); +  } +  @} +  + XML: <code>...</code> + ________________________________________________________________________________ +    Keyword: @dl - @enddl   Description: Render a definition list.   Arguments: -   Children: @item   Groups with: -   Examples: @dl    @item Britta    My first teacher. She was very nice.    @item Boris    One of the best tennis players in the universe.
pike.git/refdoc/keywords.txt:307:   ________________________________________________________________________________      Keyword: @i{ ... @}   Description: Italics.   Children: Text that will be rendered in italics.   Examples: You really look @i{italic@}! - You mean @i{Italian@}, don't you?      XML: <i>...</i>   ________________________________________________________________________________    + Keyword: @image{ ... @} + Description: Insert the specified image. + Children: The filename of the image file. + Examples: @image{chart2.png@} +  + XML: <image>...</image> + ________________________________________________________________________________ +    Keyword: @int - @endint   Description: Documentation of the different values an integer may have.   Arguments: -   Children: @value   Examples: @int    @value 0    Ignore all zonks.    @value 1    Transform zonks into flutter.    @value -1
pike.git/refdoc/keywords.txt:389:    Open the door    @item    Walk through    @item    Close the door    @endol      XML: <ol>...</ol>   ________________________________________________________________________________    + Keyword: @pre{ ... @} + Description: Preformatted text. + Children: Text that will be rendered as is, e.g. whitespaces kept. + Examples: @pre{ +  +----------+------+--------+ +  | startbit | data | endbit | +  +----------+------+--------+ +  @} +  + XML: <pre>...</pre> + ________________________________________________________________________________ +    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:456:    2 oz light rum    @item    Juice of ½ lime    @item    Coca Cola    @endul      XML: <ul>...</ul>   ________________________________________________________________________________    + Keyword: @url{ ... @} + Children: Text with markup. + Note: Might be deprecated, since it isn't used... + ________________________________________________________________________________ +    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.   ________________________________________________________________________________