summaryrefslogtreecommitdiffstats
path: root/res/goal.md
diff options
context:
space:
mode:
Diffstat (limited to 'res/goal.md')
-rw-r--r--res/goal.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/res/goal.md b/res/goal.md
new file mode 100644
index 0000000..6c6ed24
--- /dev/null
+++ b/res/goal.md
@@ -0,0 +1,66 @@
1\<MyHeader\>
2============
3
4Variables
5---------
6
7:::::: {.variable}
8
9`int MY_VARIABLE`
10=================
11
12::: {.doc}
13Documentation of this variable
14:::
15
16::::::
17
18Classes
19-------
20
21::::::::: {.class}
22
23MyClass
24=======
25
26this is a description of the class
27
28Public Types
29============
30
31- `Ptr`
32 ~ `std::shared_ptr<MyClass>`
33
34Public Member Functions
35=======================
36
37:::::: {.member-functions}
38
39:::: {.member-function}
40
41MyFunction
42==========
43
44::: {.doc}
45Hello
46:::
47
48::::
49:::: {.member-function}
50
51MyOtherFunction
52===============
53
54::: {.doc}
55This is a description
56
57Panics
58======
59
60This never panics
61:::
62::::
63
64::::::
65
66:::::::::