pike.git/
refdoc/
keywords.txt
Branch:
Tag:
Non-build tags
All tags
No tags
2001-08-20
2001-08-20 16:03:49 by Martin Nilsson <mani@lysator.liu.se>
ba132f15133b4690f342c334082833ab38152ecd (
45
lines) (+
45
/-
0
)
[
Show
|
Annotate
]
Branch:
7.9
Documentation of fixme, ol and ul.
Rev: refdoc/keywords.txt:1.3
173:
XML: <example/> ________________________________________________________________________________
+
Keyword: @fixme
+
Description: Note about something that needs fixing in the manual.
+
Arguments: -
+
Children: Text (with markup).
+
Groups with: -
+
Examples:
+
@fixme
+
The return values of this function is not correctly documented.
+
+
XML: <fixme/>
+
________________________________________________________________________________
+
Keyword: @note Description: Important information about the documented item. Arguments: -
368:
</member> ________________________________________________________________________________
+
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>
+
________________________________________________________________________________
+
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: @[ ... ]
419:
XML: <tt> ... </tt> ________________________________________________________________________________
+
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>
+
________________________________________________________________________________
+
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