Branch: Tag:

2001-09-06

2001-09-06 20:10:12 by Martin Nilsson <mani@lysator.liu.se>

Norlin exagerated a bit when he said all keywords were documented. After this checkin they are still not.

Rev: refdoc/keywords.txt:1.4

139:      ================================================================================    + 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.
260:    <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: -
314:   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: -
396:   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: @[ ... ]
463:   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