SAE-2.01/Documentation/doxygen/doxygen-awesome-css/include/MyLibrary/example.hpp

#pragma once
#include <string>

namespace MyLibrary {

enum Color { red, green, blue };

/**
 * @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
     *
     * 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            |
     *
     * A table can contain images:
     *
     * | Column 1                  | Column 2                                        |
     * |---------------------------|-------------------------------------------------|
     * | ![doxygen](testimage.png) | ← the image should not be inverted in dark-mode |
     *
     * Complex [Doxygen tables](https://www.doxygen.nl/manual/tables.html) are also supported as seen in @ref multi_row "this example":
     * 
     * <table>
     * <caption id="multi_row">Complex table</caption>
     * <tr><th>Column 1                      <th>Column 2        <th>Column 3
     * <tr><td rowspan="2">cell row=1+2,col=1<td>cell row=1,col=2<td>cell row=1,col=3
     * <tr><td rowspan="2">cell row=2+3,col=2                    <td>cell row=2,col=3
     * <tr><td>cell row=3,col=1                                  <td rowspan="2">cell row=3+4,col=3
     * <tr><td colspan="2">cell row=4,col=1+2
     * <tr><td>cell row=5,col=1              <td colspan="2">cell row=5,col=2+3
     * <tr><td colspan="2" rowspan="2">cell row=6+7,col=1+2      <td>cell row=6,col=3
     * <tr>                                                      <td>cell row=7,col=3
     * <tr><td>cell row=8,col=1              <td>cell row=8,col=2\n
     *   <table>
     *     <tr><td>Inner cell row=1,col=1<td>Inner cell row=1,col=2
     *     <tr><td>Inner cell row=2,col=1<td>Inner cell row=2,col=2
     *   </table>
     *   <td>cell row=8,col=3
     *   <ul>
     *     <li>Item 1
     *     <li>Item 2
     *   </ul>
     * </table>
     *
     * ## 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<Example>(5);
     *    example->test("test");
     * }
     * 
     * @endcode
     *
     *     // 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`:
     * @code{.c}
     * void this_looks_awesome();
     * @endcode
     *
     * @bug example bug
     *
     * @deprecated None of this will be deprecated, because it's beautiful!
     *
     * @invariant This is an invariant
     *
     * @pre This is a precondition
     *
     * @todo This theme is never finished!
     *
     * @remark This is awesome!
     *
     */
    std::string test(const std::string& test);

    virtual int virtualfunc() = 0;

    static bool staticfunc();


};

}