MyLibrary::Example Class Reference

Example class to demonstrate the features of the custom CSS. More...

#include <example.hpp>

Inheritance diagram for MyLibrary::Example:

Public Member Functions
std::string	test (const std::string &test)
	brief summary More...
virtual int	virtualfunc ()=0

Static Public Member Functions
static bool	staticfunc ()

Detailed Description

Example class to demonstrate the features of the custom CSS.

Author

jothepro

Member Function Documentation

test()

std::string MyLibrary::Example::test

(

const std::string &

test

)

brief summary

doxygen test documentation

Parameters

test	this is the only parameter of this test function. It does nothing!

Supported elements

These elements have been tested with the custom CSS.

Tables

The table content is scrollable if the table gets too wide.

first_column	second_column	third_column	fourth_column	fifth_column	sixth_column	seventh_column	eighth_column	ninth_column
1	2	3	4	5	6	7	8	9

Lists

• element 1
• element 2

1. element 1

   code in lists

2. element 2

Quotes

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Velit sed ullamcorper morbi tincidunt ornare.

Lorem ipsum dolor sit amet consectetur adipiscing elit duis.

- jothepro

Code block

auto x = "code within md fences (```)";

// code within @code block
while(true) {
   auto example = std::make_shared<Example>(5);
   example->test("test");
}

// code within indented code block
auto test = std::shared_ptr<Example(5);

Inline code elements in a text. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. This also works within multiline text and does not break the layout.

Special hints

Warning

this is a warning only for demonstration purposes

Note

this is a note to show that notes work. They can also include code:

void this_looks_awesome();

Bug:

example bug

Deprecated:

None of this will be deprecated, because it's beautiful!

Invariant

This is an invariant

Precondition

This is a precondition

Todo:

This theme is never finished!

Remarks

This is awesome!

---

The documentation for this class was generated from the following file:

• docs/doxygen-awesome-css/include/MyLibrary/example.hpp