Class Example

class Example demo

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.

constructor Example()

Example()

Constructor

Initializes the Example class. Example() ~Example()

See also: ~Example()

Fully qualified name: ns::Example::Example()

Declared at library.hpp:204

constructor Example(int)

Example(int val)

Parameterized constructor

Parameters

val	An integer to initialize the data member.

Fully qualified name: ns::Example::Example(int)

Declared at library.hpp:208

destructor ~Example()

~Example()

Destructor

Fully qualified name: ns::Example::~Example()

Declared at library.hpp:211

typedef value_type

using value_type = int

It's member typedef

Fully qualified name: ns::Example::value_type

Declared at library.hpp:214

enum Status

enum Status { … }

It's member enum

enum constant Ok

Ok    = 0

Fully qualified name: ns::Example::Status::Ok

Declared at library.hpp:219

enum constant Error

Error = 1

Fully qualified name: ns::Example::Status::Error

Declared at library.hpp:220

Fully qualified name: ns::Example::Status

Declared at library.hpp:217

struct Nested

struct Nested { … }

Nested struct

variable id

int id

Identifier

Fully qualified name: ns::Example::Nested::id

Declared at library.hpp:226

variable name

std::string_view name

Name

Fully qualified name: ns::Example::Nested::name

Declared at library.hpp:227

Fully qualified name: ns::Example::Nested

Declared at library.hpp:224

function doSomething(double, double)

Demo doSomething(double, double)

Performs an action and return Demo .

x.doSomething(3.14, 2.71);

Returns

Demo

Fully qualified name: ns::Example::doSomething(double, double)

Declared at library.hpp:239

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\)

Fully qualified name: ns::Example::multiply(T, T)

Declared at library.hpp:251

Fully qualified name: ns::Example

Declared at library.hpp:198

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.