#pragma once #include namespace MyLibrary { enum Color { red = 1, green = 2, blue = 3 }; /** * @brief Example class to demonstrate the features of the custom CSS. * * @author jothepro * */ class Example { public: /** * @brief brief summary * * doxygen test documentation * * @param 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 * *
* * - Basic * This theme supports normal markdown tables:
* | Item | Title | Description | More | * |-----:|-------|-----------------------|--------------------------------------------| * | 1 | Foo | A placeholder | Some lorem ipsum to make this table wider. | * | 2 | Bar | Also a placeholder | More lorem ipsum. | * | 3 | Baz | The third placeholder | More lorem ipsum. | * - Centered *
* A table can be centered with the `
` html tag:
* | Item | Title | Description | More | * |-----:|-------|-----------------------|--------------------------------------------| * | 1 | Foo | A placeholder | Some lorem ipsum to make this table wider. | * | 2 | Bar | Also a placeholder | More lorem ipsum. | * | 3 | Baz | The third placeholder | More lorem ipsum. | *
* - Stretched * A table wrapped in `
` fills the full page width. *
* | Item | Title | Description | More | * |-----:|-------|-----------------------|--------------------------------------------| * | 1 | Foo | A placeholder | Some lorem ipsum to make this table wider. | * | 2 | Bar | Also a placeholder | More lorem ipsum. | * | 3 | Baz | The third placeholder | More lorem ipsum. | *
* **Caution**: This will break the overflow scrolling support! * - Complex * Complex [Doxygen tables](https://www.doxygen.nl/manual/tables.html) are also supported as seen in @ref multi_row "this example":
* * *
Complex table
Column 1 Column 2 Column 3 *
cell row=1+2,col=1cell row=1,col=2cell row=1,col=3 *
cell row=2+3,col=2 cell row=2,col=3 *
cell row=3,col=1 cell row=3,col=3 *
* - Overflow Scrolling 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 | * - ImagesA table can contain images:
* | Column 1 | Column 2 | * |---------------------------|-------------------------------------------------| * | ![doxygen](testimage.png) | ← the image should not be inverted in dark-mode | * * *
* * ## Diagrams * * Graphviz diagrams support dark mode and can be scrolled once they get too wide: * * \dot Graphviz with a caption * digraph example { * node [fontsize="12"]; * rankdir="LR" * a -> b -> c -> d -> e -> f -> g -> h -> i -> j -> k; * } * \enddot * * ## 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 * * ```cpp * auto x = "code within md fences"; * ``` * * @code{.cpp} * // code within @code block * while(true) { * auto example = std::make_shared(5); * example->test("test"); * } * @endcode * * // code within indented code block * auto test = std::shared_ptr