pike.git
/
refdoc
/
keywords.txt
version
»
Context lines:
10
20
40
80
file
none
3
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/>