<doc />
Element in RAD Modules
Use the <doc />
element to define larger blocks of content. The <doc />
element might contain inline elements, block elements or text data. The <doc />
element is displayed as separate blocks of data and can contain the following elements:
-
<heading />
-
Defines a section heading.
-
<para />
-
Defines a paragraph.
-
<list />
-
Defines a list of items. Items in the list are defined by an
<item />
element. The<list />
element takes an optional attribute that defines the type of list to display using theordered
attribute for a numbered list orunordered
attribute for a bullet list. The default list type is an unordered list. -
<item />
-
Defines an item in a list. It might contain block or inline elements.
-
<example />
-
Displays a program listing. Available attributes are:
-
language
-
A mandatory attribute which defines the programming language. It can have any one of
c
,python
,java
,rest
, orcurl
. The value must be in lowercase. -
caption
-
An optional attribute, which provides a label for the example.
-
numbered
-
An optional attribute. Displays line numbers. Default is to omit line numbers.
-
-
<verbatim />
-
Defines a block of text in which line breaks and whitespace are preserved.
For more information about how to use the documentation definitions, see RAD Module Example.