Close
The following table lists the commonly used XML tags and shows how these tags are supported by Doc-O-Matic. You can change the default setting for tags that are mapped to sections not section text. If text appears as a specific section these settings can not be changed.
|
XML Tag |
Doc-O-Matic Section and Style Mapping |
|
<c> |
Interpreted as <c> |
|
<code> |
Interpreted as <code> |
|
<para> |
Interpreted as <p> |
|
<see> |
Interpreted as <link name> |
|
<typeparamref> |
Text |
|
<param> |
Parameter description for method parameters |
|
<typeparam> |
Parameter description for generic types |
|
<seealso> |
Links appear as entries in the See Also section |
|
<returns> |
Section: Returns |
|
<exception cref="MyException"> MyException will be triggered if something goes wrong.</exception> |
Mapped to section Exceptions (type Value Description) |
|
<value> |
Section: Description |
|
<remarks> |
Section: Remarks |
|
<example> |
Section: Examples |
|
<summary> |
Section: Summary |
|
<permission> |
Section: Conditions |
|
<include> |
Not supported |
|
<list> |
Non supported |
|
<retval> |
Text appears as Return Values section. |
See Also
    |
Expand All