5b53672003-04-01Martin Nilsson This document describes the keywords recognized by the AutoDoc parser, and their intended use.
6370002001-02-12David Norlin 
5b53672003-04-01Martin Nilsson ===============================================================================
6370002001-02-12David Norlin  META KEYWORDS
5b53672003-04-01Martin Nilsson ===============================================================================
6370002001-02-12David Norlin  Keyword: @appears Description: Tell where the documentation for an item should be shown.
5b53672003-04-01Martin Nilsson  Gives the full new name of the item. Must be placed first in the block, or immediately after any @module, @class, or @decl's.
94aa302001-02-26Johan Sundström Arguments: <name> [, type]
6370002001-02-12David Norlin  Where:
5b53672003-04-01Martin Nilsson  <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. [type] is either "class" or "module" depending on whether the target item should appear as a class or a module. When not present, the choice will be governed by the item's type, as detected by the extractor. Overriding this is only needed for odd special cases such as a module.pmod containing e g:
94aa302001-02-26Johan Sundström  static class _Foo {...}; _Foo Foo = _Foo();
6370002001-02-12David Norlin Children: - Groups with: - Examples: //! @appears predef::stat //! This function is globally visible. array stat() { // function body }
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @belongs
5b53672003-04-01Martin Nilsson Description: Tell where the documentation for an item should be shown. Gives the name of the new parent module or parent class.
6370002001-02-12David Norlin Arguments: <name> Where:
5b53672003-04-01Martin Nilsson  <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.
6370002001-02-12David Norlin Children: - Groups with: - Examples: //! @decl int func() //! @belongs AnotherModule
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @class
5b53672003-04-01Martin Nilsson Description: Declare and enter a new scope for a class. Only in C mode. Until an @endclass is found, all declarations will be regarded as children of the class.
6370002001-02-12David Norlin Arguments: <name> Where:
5b53672003-04-01Martin Nilsson  <name> is a valid Pike identifier. Not the "absolute" name with dots.
6370002001-02-12David Norlin Children: Documentation for the class, or empty. Groups with: - Examples: /*! @class Arne *! A class with a Swedish name. */
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @decl
5b53672003-04-01Martin Nilsson  Description: Declare a Pike entity and state that the current documentation block "is about" that entity. If the documentation block is bound to a Pike entity by adjacency (if it is a Pike file being extracted), then @decl is allowed iff:
6370002001-02-12David Norlin  1. The Pike entity in the adjacent code is one method.
5b53672003-04-01Martin Nilsson  2. All @decl's in the block are methods with the same name as that method. (look at the last example below)
01dc2a2011-01-26Martin Stjernholm  The rest of the line after @decl should follow real pike syntax, but the ending semicolon is optional. There are some differences though, notably it allows a type to be specified for constants.
6370002001-02-12David Norlin Arguments: <declaration> Where:
5b53672003-04-01Martin Nilsson  <declaration> is a valid Pike declaration. A trailing ";" is optional. Children: Documentation for the entity. After all @decl's may follow one of @appears or @belongs.
6370002001-02-12David Norlin Groups with: @decl Examples: //! @decl void explode(string victim); //! @decl float root(float x) //! @decl mapping(string:string) arguments; //! Doc for these three disparate things. //! @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 */ }
01dc2a2011-01-26Martin Stjernholm  //! @decl constant int bitmask //! A constant which has a public type but private value.
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @endclass Description: Leave the class scope entered by @class. Arguments: [name] Where:
5b53672003-04-01Martin Nilsson  [name] if present, must be the same as the argument to @class.
6370002001-02-12David Norlin Children: Groups with: - Examples: /*! @endclass Reinhold */
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @endmodule Description: Leave the module scope entered by @module Arguments: [name] Where:
5b53672003-04-01Martin Nilsson  [name] if present, must be the same as the argument to @module.
6370002001-02-12David Norlin Children: - Groups with: - Examples: /*! @endmodule Roine */
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
90c0212002-12-11Henrik Grubbström (Grubba) Keyword: @endnamespace
5b53672003-04-01Martin Nilsson Description: Leave the namespace entered by @namespace. Symbols defined outside a namespace will be defined in the default namespace "predef::".
90c0212002-12-11Henrik Grubbström (Grubba) Arguments: [name] Where: [name] if present, must be the same as the argument to
5b53672003-04-01Martin Nilsson  @namespace.
90c0212002-12-11Henrik Grubbström (Grubba) Children: - Groups with: - Examples: /*! @endnamespace lfun:: */
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
90c0212002-12-11Henrik Grubbström (Grubba) 
d5297c2004-03-02Martin Nilsson 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: - Examples: //! @class XHTML //! @inherit XML _______________________________________________________________________________
6370002001-02-12David Norlin Keyword: @module
5b53672003-04-01Martin Nilsson Description: Declare and enter a new scope for a module. Only in C mode. Until an @endmodule is found, all declarations will be regarded as children of the module.
6370002001-02-12David Norlin Arguments: <name> Where:
5b53672003-04-01Martin Nilsson  <name> is a valid Pike identifier. Not the "absolute" name with dots.
6370002001-02-12David Norlin Children: Documentation for the module, or empty. Groups with: - Examples: /*! @module Kenny *! A module with a Norwegian name. */
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
90c0212002-12-11Henrik Grubbström (Grubba)  Keyword: @namespace Description: Declare and enter a new namespace. Only in C mode. Until
5b53672003-04-01Martin Nilsson  an @endnamespace is found, all declarations will be regarded as living in this namespace.
90c0212002-12-11Henrik Grubbström (Grubba) Arguments: <name>[::] Where:
5b53672003-04-01Martin Nilsson  <name> is a valid Pike identifier. Not the "absolute" name with dots.
90c0212002-12-11Henrik Grubbström (Grubba) Children: Documentation for symbols in the namespace, or empty. Groups with: - Examples: /*! @namespace lfun:: *! The operator callback API. */
5b53672003-04-01Martin Nilsson _______________________________________________________________________________ ===============================================================================
6370002001-02-12David Norlin  DELIMITER KEYWORDS AT THE TOP LEVEL
5b53672003-04-01Martin Nilsson ===============================================================================
6370002001-02-12David Norlin 
7d0a262001-09-06Martin Nilsson Keyword: @bugs
5b53672003-04-01Martin Nilsson Description: Document shortcomings of the current block module/class/function
7d0a262001-09-06Martin Nilsson Arguments: - Children: Text (with markup). Groups with: - Examples: @bugs
5b53672003-04-01Martin Nilsson  Converted images with bigger size than 512x512 pixels will be distorted in the corners.
7d0a262001-09-06Martin Nilsson  XML: <bugs/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
7d0a262001-09-06Martin Nilsson 
6370002001-02-12David Norlin Keyword: @deprecated
5b53672003-04-01Martin Nilsson Description: Documents the fact that the entity is deprecated by one or several other classes/modules/methods/variables.
6370002001-02-12David Norlin Arguments: [item_1 [, item_2 [, item_3 ... ]]] Where:
5b53672003-04-01Martin Nilsson  [item_n] is an "absolute" name pointing to a Pike entity. It may use the 'scope::' prefix.
6370002001-02-12David Norlin Children: - Groups with: @deprecated Examples: //! @deprecated IO.initPrinter, IO.sendPrinterCommand //! @deprecated predef::search
652b482001-06-14David Norlin XML: `@deprecated Foo, Bar' => <deprecated> <name>Foo</name> <name>Bar</name> </deprecated>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @example Description: Example code for the documented item. Arguments: - Children: Text (with markup). Groups with: - Examples: @example array a = func(); if (sizeof(a) > MAX) // security check exit(1);
652b482001-06-14David Norlin XML: <example/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
ba132f2001-08-20Martin Nilsson Keyword: @fixme Description: Note about something that needs fixing in the manual. Arguments: - Children: Text (with markup). Groups with: - Examples: @fixme
5b53672003-04-01Martin Nilsson  The return values of this function is not correctly documented.
ba132f2001-08-20Martin Nilsson XML: <fixme/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
ba132f2001-08-20Martin Nilsson 
6370002001-02-12David Norlin Keyword: @note Description: Important information about the documented item. Arguments: - Children: Text (with markup). Groups with: - Examples: @note
5b53672003-04-01Martin Nilsson  Do not call this function unless you know what you are doing. No bounds/sanity checking on arguments is performed!
6370002001-02-12David Norlin 
652b482001-06-14David Norlin XML: <note/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @param Description: Documentation for a method parameter. Only allowed when documenting functions. Arguments: <name> Where: <name> is a valid Pike parameter name. Children: The documentation for the parameter. Groups with: @param Examples: @param x @param y The coordinates of the thing. @param name The name of the thing.
652b482001-06-14David Norlin XML: `@param Foo' => <param name="Foo"/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @returns
5b53672003-04-01Martin Nilsson Description: Documentation for the return value of a method. The type of the return value is deduced from the declaration.
6370002001-02-12David Norlin Arguments: - Children: The doc. Groups with: - Examples: @returns
5b53672003-04-01Martin Nilsson  The square root of the sum of the cubes of the inverse numbers.
6370002001-02-12David Norlin 
652b482001-06-14David Norlin XML: <returns/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @seealso
5b53672003-04-01Martin Nilsson Description: Refer to other stuff that is related to the entity in question.
6370002001-02-12David Norlin Arguments: - Children: Text (with markup). Groups with: - Examples: //! @seealso //! @[calc_checksum_w()] is used for wide strings.
652b482001-06-14David Norlin XML: <seealso/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
f685852003-02-11Martin Nilsson  Keyword: @throws
5b53672003-04-01Martin Nilsson Description: Describes the conditions for an exception to be thrown from the function.
f685852003-02-11Martin Nilsson Arguments: - Children: Text (with markup). Groups with: - Examples: //! @throws //! Throws an exception if the file could not be created. XML: <throws/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________ ===============================================================================
6370002001-02-12David Norlin  TEXT MARKUP KEYWORDS
5b53672003-04-01Martin Nilsson ===============================================================================
6370002001-02-12David Norlin  Keyword: @array - @endarray Description: Documentation of the layout of an array.
2315892002-07-29Martin Nilsson Arguments: [name]
6370002001-02-12David Norlin Children: @elem Groups with: - Examples: @array @elem mixed 0.. All elements are of type mixed. @endarray
652b482001-06-14David Norlin XML: `@array Foo' => <array name="Foo">
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
7d0a262001-09-06Martin Nilsson 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>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
7d0a262001-09-06Martin Nilsson 
d705c72003-04-01Martin Nilsson Keyword: @code ... @endcode
7d0a262001-09-06Martin Nilsson Description: Encapsulates a code block. Children: Text that will be rendered as program code.
d705c72003-04-01Martin Nilsson Examples: @code
7d0a262001-09-06Martin Nilsson  int fac(int i) { if(i<2) return i; return i*fac(i-1); }
d705c72003-04-01Martin Nilsson  @endcode
7d0a262001-09-06Martin Nilsson  XML: <code>...</code>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
7d0a262001-09-06Martin Nilsson 
6370002001-02-12David Norlin 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. @enddl
652b482001-06-14David Norlin XML: <dl>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @elem
5b53672003-04-01Martin Nilsson Description: Documentation for an array element or a range of array elements. Only inside @array - @endarray.
6370002001-02-12David Norlin Arguments: <type> <index range> Where: <type> is the Pike type of the element at the index. <index range> is one of the following: number (at index number only) number.. (from number to end of array) number1..number2 (from number1 to inclusive number2) ..number (from beginning to inclusive number) And number can be an integer literal or an identifier: 4711 -42 MAX Children: Documentation for the array elements at the given index or indices. Groups with: @elem Examples: @elem int 0 The first element is an integer. @elem string 1.. The rest of the elements are strings. @elem array(string) MIN..MAX The elements at these positions are themselves arrays.
652b482001-06-14David Norlin XML: `@elem string 1..2' => <elem> <type><string/></type> <minindex>1</minindex> <maxindex>2</maxindex> </elem>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
d705c72003-04-01Martin Nilsson Keyword: @expr{ ... @} Description: Mark up a code expression. Children: Text that will be rendered in a fixed font. Examples: The expression @{i=i++@} is a noop. XML: <expr>...</expr> _______________________________________________________________________________
6370002001-02-12David Norlin Keyword: @i{ ... @} Description: Italics. Children: Text that will be rendered in italics.
5b53672003-04-01Martin Nilsson Examples: You really look @i{italic@}! - You mean @i{Italian@}, don't you?
6370002001-02-12David Norlin 
652b482001-06-14David Norlin XML: <i>...</i>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
7d0a262001-09-06Martin Nilsson Keyword: @image{ ... @} Description: Insert the specified image. Children: The filename of the image file. Examples: @image{chart2.png@} XML: <image>...</image>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
7d0a262001-09-06Martin Nilsson 
cec86d2001-07-30Martin Nilsson Keyword: @int - @endint
5b53672003-04-01Martin Nilsson Description: Documentation of the different values an integer may have.
2315892002-07-29Martin Nilsson Arguments: [name]
cec86d2001-07-30Martin Nilsson Children: @value Examples: @int @value 0 Ignore all zonks. @value 1 Transform zonks into flutter. @value -1 Remove all zonks. @value 5..10 Do something. @value 17.. Do something else.
e409802003-07-03Martin Nilsson  @endint
cec86d2001-07-30Martin Nilsson 
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
cec86d2001-07-30Martin Nilsson 
6370002001-02-12David Norlin Keyword: @item Description: A definition term inside @dl Arguments: <name> Where: <name> is any string that will be the name of the term. Children: Text (with markup) Groups with: @item Examples:
652b482001-06-14David Norlin XML: <item name="..."/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @mapping - @endmapping Description: Documentation of the layout of a mapping.
2315892002-07-29Martin Nilsson Arguments: [name]
6370002001-02-12David Norlin Children: @member Examples: @mapping @member int "ip" The IP# of the host. @member string "address" The name of the host. @endmapping
652b482001-06-14David Norlin XML: <mapping name="..."/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @member Description: Documentation for a member of a mapping. Only inside @mapping - @endmapping. Arguments: <type> <index_value> Where: <type> is the Pike type of the value stored at the index. <index_value> is the index value. Can be a string or integer literal, or an identifier. Children: - Groups with: - Examples: @member string "name" @member int "age" These two entries in the mapping provide personal data.
80ec472001-07-10David Norlin XML: `@member float "foo"' => <member> <type><float/></type> <index>"foo"</index> </member>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
0df52a2004-03-02Martin Nilsson Keyword: @mixed - @endmixed Description: Documentation of a mixed variable Arguments: [name] Children: @type Examples: @mixed @type int Integers will be treated as the Unicode character number. @type string Strings are the name of the Unicdoe character. @endmixed XML: <mixed name="..."/> _______________________________________________________________________________
d9bf702002-07-27Martin Nilsson Keyword: @multiset - @endmultiset Description: Documentation of the layout of a multiset.
2315892002-07-29Martin Nilsson Arguments: [name]
d9bf702002-07-27Martin Nilsson Children: @index Examples: @multiset @index "cat" It's raining cats. @index "dog" It's raining dogs @endmultiset XML: <multiset name="..."/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
d9bf702002-07-27Martin Nilsson  Keyword: @index Description: Documentation for a index in a multiset. Only inside @multiset - @endmultiset. Arguments: <index_value> Where:
5b53672003-04-01Martin Nilsson  <index_value> is the index value. Can be a string or integer literal, or an identifier.
d9bf702002-07-27Martin Nilsson Children: - Groups with: - Examples: @index "cat" @index "dog"
5b53672003-04-01Martin Nilsson  If present, these symbols signifies that it is raining animals.
d9bf702002-07-27Martin Nilsson  XML: `@index "foo"' => <index>"foo"</index>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
d9bf702002-07-27Martin Nilsson 
ba132f2001-08-20Martin Nilsson 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>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
ba132f2001-08-20Martin Nilsson 
7d0a262001-09-06Martin Nilsson 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>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
7d0a262001-09-06Martin Nilsson 
6370002001-02-12David Norlin Keyword: @ref{ ... @}
5b53672003-04-01Martin Nilsson Description: A reference to a Pike entity. There is also a shortcut for this keyword, since it is expected to be so common: @[ ... ]
6370002001-02-12David Norlin Children: Text that will be interpreted as a Pike name. Groups with: -
5b53672003-04-01Martin Nilsson  Examples: My favourite class is @ref{Vanilla.Ice.Cream@}, it tastes much better than @[Nougat.Glass] or @[`+].
6370002001-02-12David Norlin 
80ec472001-07-10David Norlin XML: <ref>...</ref>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin  Keyword: @section - @endsection Description: Begin a new section in the text. Arguments: <name> Where: <name> is any text that is the name of the section. Children: Text (with markup) Groups with: - Examples: @section One - Introduction ... @endsection @section Two - Intrinsics & Details about the Interface ... @endsection
80ec472001-07-10David Norlin XML: <section name=" ... ">
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
cec86d2001-07-30Martin Nilsson Keyword: @string - @endstring Description: Documentation of the layout of a mapping.
2315892002-07-29Martin Nilsson Arguments: [name]
cec86d2001-07-30Martin Nilsson Children: @value Examples: @string @value "GMT" Greenwich Mean Time @value "CET" Central European Time @endstring XML: <string name=" ... "/>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
cec86d2001-07-30Martin Nilsson 
0df52a2004-03-02Martin Nilsson Keyword: @sub{ ... @} Description: Subscript Children: Text that will be rendered in subscript. Examples: The variable n@sub{0@} looks mathematical and serious. XML: <sub> ... </sub> _______________________________________________________________________________ Keyword: @sup{ ... @} Description: Superscript Children: Text that will be rendered in superscript. Examples: This is an O(n@sup{2@}) operation. XML: <sup> ... </sup> _______________________________________________________________________________
6370002001-02-12David Norlin Keyword: @tt{ ... @} Description: Teletype. Children: Text that will be rendered in teletype. Examples: Type @tt{rm -rf *@} to erase several days of work.
80ec472001-07-10David Norlin XML: <tt> ... </tt>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
0df52a2004-03-02Martin Nilsson Keyword: @type Description: Documentation for a type alternative to mixed. Only inside @mixed - @endmixed. Arguments: <type> Children: - Groups with: - Examples: @type int @type float If the argument is int or float the function will wait that many seconds. XML: `@type int' => <type><int/></type> _______________________________________________________________________________
ba132f2001-08-20Martin Nilsson 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>
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
ba132f2001-08-20Martin Nilsson 
7d0a262001-09-06Martin Nilsson Keyword: @url{ ... @} Children: Text with markup. Note: Might be deprecated, since it isn't used...
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
7d0a262001-09-06Martin Nilsson 
6370002001-02-12David Norlin Keyword: @xml{ ... @}
5b53672003-04-01Martin Nilsson 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.
6370002001-02-12David Norlin Children: Text with markup. Examples: @xml{<b>Bold</b> and @i{italic@}@}
80ec472001-07-10David Norlin XML: No representation.
5b53672003-04-01Martin Nilsson _______________________________________________________________________________
6370002001-02-12David Norlin 
64b6de2002-11-06Marek Habersack Keyword: @ignore - @endignore
5b53672003-04-01Martin Nilsson Description: Ignores the block of code enclosed between the two keywords. Useful for code that the AutoDoc parser cannot understand.
64b6de2002-11-06Marek Habersack Children: - Examples: @ignore array PROXY(_indices, ::_indices()); array PROXY(_values, ::_values()); @endignore
5b53672003-04-01Martin Nilsson _______________________________________________________________________________