summaryrefslogtreecommitdiffstats
path: root/examples/goal.md
blob: 6c6ed245bc2fd5d038bb43bec1ecd827fe04c513 (plain)
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
\<MyHeader\>
============

Variables
---------

:::::: {.variable}

`int MY_VARIABLE`
=================

::: {.doc}
Documentation of this variable
:::

::::::

Classes
-------

::::::::: {.class}

MyClass
=======

this is a description of the class

Public Types
============

- `Ptr`
  ~ `std::shared_ptr<MyClass>`

Public Member Functions
=======================

:::::: {.member-functions}

:::: {.member-function}

MyFunction
==========

::: {.doc}
Hello
:::

::::
:::: {.member-function}

MyOtherFunction
===============

::: {.doc}
This is a description

Panics
======

This never panics
:::
::::

::::::

:::::::::