Doxybook Example

Doxybook Example #

This is a mainpage of Doxybook example output. This file is generated from \mainpage command within Engine.hpp file.

Images: #

doxygen.png

Refs: #

Simple list: #

  • list item 1
    • sub item 1
      • sub sub item 1 with italic
      • sub sub item 2 with bold
    • sub item 2
  • list item 2
    • sub item 3
      • sub sub item 3 with strike through
      • sub sub item 4 with monospaced

Enumerated list: #

  1. list item 1
    • sub item 1
      • sub sub item 1 with italic
      • sub sub item 2 with bold
    • sub item 2
  2. list item 2
    • sub item 3
      • sub sub item 3 with strike through

Code blocks: #

#include <iostream>

int main(int argc, char** argv) {
    std::cout << "Hello World" << std::endl;
    return 0;
}

Subpages: #

This manual is divided in the following sections:

Snippet: #


#include "Engine.hpp"

// A dummy example 
int main() {
    // Create pixels buffer
    const auto pixels = std::make_unique<uint8_t[]>(new uint8_t[1024*1024*3]);
    fillData(*pixels, "path/to/texture.png");

    // Create a texture out of the pixels
    Engine::Graphics::Texture2D texture(1024, 1024, *data);

    // Done
    return 0;
}

Filename: example-1.cpp

Table: #

First Header Second Header Third Header
Content Cell Content Cell Content Cell with ref Engine::Audio::AudioBuffer
Content Cell Content Cell Content Cell with link

Inline formula #

Please see mkdocs-readthedocs example at https://alandefreitas.github.io/doxybook/mkdocs-readthedocs/ to see a working example using mkdocs + pymdownx.arithmatex

The distance between ((x_1,y_1)) and ((x_2,y_2)) is (\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}).

Block formula #

[ |I_2|=\left| \int_{0}^T \psi(t) \left{ u(a,t)- \int_{\gamma(t)}^a \frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t),d\xi \right} dt \right| ]

Blockquote #

This is some random blockquote!


Updated on 2023-04-03