pike.git
/
refdoc
/
keywords.txt
version
»
Context lines:
10
20
40
80
file
none
3
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 */
pike.git/refdoc/keywords.txt:214:
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: @copyright
+
Description: Inform about implementor(s) and/or license.
+
Arguments: -
+
Children: Text (with markup).
+
Groups with: -
+
Examples: //! @copyright
+
//! Licenced under single-clause BSD.
+
+
XML: <copyright/>
+
_______________________________________________________________________________
+
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:319:
question. Arguments: - Children: Text (with markup). Groups with: - Examples: //! @seealso //! @[calc_checksum_w()] is used for wide strings. XML: <seealso/> _______________________________________________________________________________
+
Keyword: @thanks
+
Description: Inform about people and/or organisations that have helped
+
with the implementation.
+
Arguments: -
+
Children: Text (with markup).
+
Groups with: -
+
Examples: //! @thanks
+
//! Thanks to Lysator Academic Computer Society for
+
//! providing computer resources for testing this.
+
+
XML: <thanks/>
+
_______________________________________________________________________________
+
Keyword: @throws Description: Describes the conditions for an exception to be thrown from the function. Arguments: - Children: Text (with markup). Groups with: - Examples: //! @throws //! Throws an exception if the file could not be created. XML: <throws/>
pike.git/refdoc/keywords.txt:597:
@[ ... ] 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> _______________________________________________________________________________
+
Keyword: @rfc{ ... @}
+
Description: Reference to an RFC and optionally a section or appendix.
+
Children: RFC number and optionally a colon followed by section number
+
or appendix letter.
+
Groups with: -
+
+
Examples:
+
The @[MIME] module implements @rfc{1521@}.
+
+
See @rfc{7540:5.3@} for details about @[ADT.TreeScheduler].
+
+
The list of static headers for HPack is defined in @rfc{7541:A@}.
+
+
XML: <rfc>...</rfc>
+
_______________________________________________________________________________
+
Keyword: @section - @endsection Description: Begin a new section in the text. Sections cannot be nested. Arguments: <title> Where: <title> is any text that is the title of the section. Children: Text (with markup) Groups with: - Examples: @section One - Introduction ...