Presentation

Name	Description
f	Function with documentation demonstrating various presentation features.
g	Function with documentation demonstrating various presentation features, this time using end-of-line comments.
h	Function demonstrating all possible annotations.
i	Function demonstrating all possible annotations, this time using end-of-line comments.

int f(int x, int y)

Function with documentation demonstrating various presentation features.

Lists

Itemized list:

Itemized list item.
Itemized list item.
- Nested itemized list item.
Itemized list item.

Numbered list:

Enumerated list item.
Enumerated list item. - Nested itemized list item.
Enumerated list item.

Tables

Column 1	Column 2	Column 3
Row 1, Column 1	Row 1, Column 2	Row 1, Column 3
Row 2, Column 1	Row 2, Column 2	Row 2, Column 3
Row 3, Column 1	Row 3, Column 2	Row 3, Column 3

Code

void f(int x, int y);

/* nested comment in code */
void f(int x, int y);

Math

The expected value of a continuous random variable $X$ , denoted $\mathbb{E}(X)$ , is given by:

$\mathbb{E}(X) = \int_{-\infty}^\infty x p(x) \mathrm{d}x.$

Images

Headings

Heading 5

Heading 6

Admonitions

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

int g(int x, int y)

Function with documentation demonstrating various presentation features, this time using end-of-line comments.

Lists

Itemized list:

Itemized list item.
Itemized list item.
Itemized list item.

Numbered list:

Enumerated list item.
Enumerated list item.
Enumerated list item.

Tables

Column 1	Column 2	Column 3
Row 1, Column 1	Row 1, Column 2	Row 1, Column 3
Row 2, Column 1	Row 2, Column 2	Row 2, Column 3
Row 3, Column 1	Row 3, Column 2	Row 3, Column 3

Code

void f(int x, int y);

/// nested comment in code
void f(int x, int y);

Images

Headings

Heading 5

Heading 6

Admonitions

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

template<class T> int h(int x, int y, int& z, int& w)

Function demonstrating all possible annotations.

T: Template parameter.
x: Input parameter.
y: Input parameter.
z: Output parameter.
w: Input-output parameter.
u: Input parameter with a description that spans across multiple lines.
Return: Return value.
Pre-condition: Pre-condition.
Post-condition: Post-condition.
Throw: Exception.
See: f

template<class T> int i(int x, int y, int& z, int& w)

Function demonstrating all possible annotations, this time using end-of-line comments.

T: Template parameter.
x: Input parameter.
y: Input parameter.
z: Output parameter.
w: Input-output parameter.
u: Input parameter with a description that spans across multiple lines.
Return: Return value.
Pre-condition: Pre-condition.
Post-condition: Post-condition.
Throw: Exception.
See: f

Presentation

Functions

Function Details

f

Lists

Tables

Code

Math

Images

Headings

Heading 5

Heading 6

Admonitions

g

Lists

Tables

Code

Images

Headings

Heading 5

Heading 6

Admonitions

h

i