class Example example

class Example { … }

Example class demonstrating documentation.

This class serves as an example for documenting C++ code using Doxygen-style comments.

Note

This is a note about the Example class.

Warning

This is a warning about the Example class.

Example Multiplies two values.

Template parameters

T	A numeric type.

Parameters

a	First value.
b	Second value.

Returns

The product of a and b.

Remark

Markdown formula: \(a \cdot b\)

constructor Example()

Example()

Constructor

Initializes the Example class.

See also:

@ref ~Example()

Defined at library.hpp:163

constructor Example(int)

Example(int val)

Parameterized constructor

Parameters

val	An integer to initialize the data member.

Defined at library.hpp:167

destructor ~Example()

~Example()

Destructor

Defined at library.hpp:170

typedef value_type

using value_type = int

It's member typedef

Defined at library.hpp:173

enum Status

enum Status { … }

It's member enum

enum constant Ok

Ok    = 0

Defined at library.hpp:178

enum constant Error

Error = 1

Defined at library.hpp:179

Defined at library.hpp:176

struct Nested

struct Nested { … }

Nested struct

variable id

int id

Identifier

Defined at library.hpp:185

variable name

std::string_view name

Name

Defined at library.hpp:186

Defined at library.hpp:183

function doSomething(double, double)

Demo doSomething(double, double)

Performs an action and return Demo .

x.doSomething(3.14, 2.71);

Returns

Demo

Defined at library.hpp:198

function multiply(T, T)

template <typename T>
T multiply(T a, T b)

Multiplies two values.

Template parameters

T	A numeric type.

Parameters

a	First value.
b	Second value.

Returns

The product of a and b.

Remark

Markdown formula: \(a \cdot b\)

Defined at library.hpp:210

Defined at library.hpp:157