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
#include <cstdarg>
#include <cstdint>
#include <cstdlib>
#include <ostream>
#include <new>
extern "C" {
/// Some docs.
extern const uint32_t FOO;
/// The root of all evil.
///
/// But at least it contains some more documentation as someone would expect
/// from a simple test case like this.
///
/// # Hint
/// Always ensure that everything is properly documented, even if you feel lazy.
/// **Sometimes** it is also helpful to include some markdown formatting.
///
/// ////////////////////////////////////////////////////////////////////////////
///
/// Attention:
///
/// This is an indentation test.
/// The indentation should be preserved in the generated documentation.
///
/// ...and here is my shopping list to check that we do not mess with line breaks and indentation:
/// - Bread
/// - Brown
/// - White
/// - Milk
/// - Eggs
void root();
/// In this block, we're testing indentation handling.
/// Since all of these lines are equally indented, we want to discard the common leading whitespace,
/// but preserve the relative indentation and line breaks.
///
/// Including between paragraphs,
///
/// - And
/// - within
/// - Lists
void block_function();
} // extern "C"