/
DOCUMENTATION
127 lines (126 loc) · 1.93 KB
/
DOCUMENTATION
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
Opa Documentation format :
/**
* {1 Tests}
*
* [[**] ]
* [ [ **] ]
* [ [** ]]
* [[* *] ]
* [ [**] ]
* [ [**] [**] ]
* [ [ [**] ] ]
*
* [[]]
* [[][]]
* [[[]]]
* [{}]
* [{}{}]
* [{{}}]
*
* [[t[]]]
*
* {{}}
* {{}{}}
* {{{}}}
* {[]}
* {[][]}
* {[[]]}
*
* {[{t{}}}
* {[{% \emph{Hello \latex}}}
*
* {1 Syntax of documentation comments}
*
* Comments in an Opa file are parsed by opadoc to produce associated
* documentation. A special syntax can be used within these comments in order
* to organize the produced documentation and make it look better.
*
* You can either write independent documentation comments or associate them to
* code elements (functions, modules...) by placing them just before the
* element they describe.
*
* {2 Structure}
*
* You can use the following tags to organize the documentation into different
* parts.
*
* Square and curly brackets can be used inside formatting brackets without
* being escaped as long as they go in pair (opening and closing ones). If
* you'd like to use a single opening or closing bracket, you should escape it
* with a backslash.
*
* {3 Headings}
*
* {[
* {1 Heading1}
* {2 Heading2}
* {3 Heading3}
* {4 Heading4}
* {5 Heading5}
* {6 Heading6}
* }
*
* {3 Text formats}
*
* {4 Basic styles}
*
* {b bold}: [{b bold}]
*
* {it italic}: [{it italic}]
*
* {emp emphasize}: [{emp emphasize}]
*
* {^ superscript}: [{^ superscript}]
*
* {_ subscript}: [{_ subscript}]
*
* {4 Alignments }
*
* {C center} [{C
* center
* }]
* {L left} [{L
* left
* }]
* {R center} [{C
* center
* }]
*
* {4 Code}
*
* {[
* {[
* ...
* your code here
* ...
* }
* }
*
* {4 Verbatim}
*
* {[
* {v
* ...
* verbatim text here
* ...
* }
* }
*
* {4 Lists}
*
* {ul ul}
*
* {enum enum}
*
* {4 Raw LaTeX}
*
* {[
* {% \emph{Hello \latex}}
* }
*
* {4 Custom}
*
* {[
* {custom custom tag}
* }
*/