-
Notifications
You must be signed in to change notification settings - Fork 2
/
SYNTAX
66 lines (47 loc) · 1.23 KB
/
SYNTAX
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
Text Elements:
<p>
<example>
<strong>
<em>
<code>
<br />
Paragraph markup is automatically inserted when two new-lines are present between two text blocks.
So using <p> is rarely needed.
List Elements:
<list> or <ul>
A simple, unnumbered list of items, each contained within an <item> or <li> tag.
<enum>
A numbered list (<item> or <ol> tags).
<deflist> or <dl>
A list of terms with definitions, marked as alternating <term> or <dt> and <desc> or <dd> tags.
Header Elements:
<title>
<abstract>
<author><email>
<version>
<date>
<copy>
In addition, we can parse the following declarations that corresponds to <copy>, <author> and <date>:
Copyright © Year Name
Author: or Authors: name mailaddress
Date:
/** <title>DocPageWeaver</title>
<abstract>A documentation builder that produce pages based on the input
content.</abstract>
Copyright (C) 2010 Quentin Mathe
Author: Quentin Mathe <[email protected]>
Date: November 2010
License: Modified BSD (see COPYING)
*/
Method/Function Description Elements:
- text and list elements
- @param
- @return
- @task
and text and list elements
In-Between Method or Function Elements:
- @taskunit
Class, protocol and category description Elements:
- text and list elements
- @section
- @group