___
This commit is contained in:
parent
e1e0d1cbd5
commit
de74aac8af
@ -1,29 +0,0 @@
|
|||||||
name: publish
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
runs-on: ubuntu-20.04
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- name: install Doxygen 1.9.2
|
|
||||||
run: |
|
|
||||||
sudo apt-get update
|
|
||||||
sudo apt-get install -y graphviz libclang-cpp1-9 libclang1-9
|
|
||||||
wget https://www.doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz
|
|
||||||
tar -xvzf doxygen-1.9.2.linux.bin.tar.gz
|
|
||||||
ln -s doxygen-1.9.2/bin/doxygen doxygen
|
|
||||||
- name: set version
|
|
||||||
run: echo "PROJECT_NUMBER = `git describe --tags`" >> Doxyfile
|
|
||||||
- name: Generate Documentation
|
|
||||||
run: ./doxygen Doxyfile
|
|
||||||
- name: Publish generated content to GitHub Pages
|
|
||||||
uses: tsunematsu21/actions-publish-gh-pages@v1.0.1
|
|
||||||
with:
|
|
||||||
dir: docs/html
|
|
||||||
branch: gh-pages
|
|
||||||
token: ${{ secrets.ACCESS_TOKEN }}
|
|
||||||
3
doxygen-awesome-css/.gitignore
vendored
3
doxygen-awesome-css/.gitignore
vendored
@ -1,3 +0,0 @@
|
|||||||
docs/html
|
|
||||||
.DS_Store
|
|
||||||
.idea
|
|
||||||
File diff suppressed because it is too large
Load Diff
@ -1,110 +0,0 @@
|
|||||||
#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 |
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* ## 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();
|
|
||||||
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
@ -1,36 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
#include <string>
|
|
||||||
#include "example.hpp"
|
|
||||||
#include <iostream>
|
|
||||||
|
|
||||||
namespace MyLibrary {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief some subclass
|
|
||||||
*/
|
|
||||||
class SubclassExample : public Example {
|
|
||||||
public:
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @bug second bug
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
int virtualfunc() override;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Extra long function with lots of parameters
|
|
||||||
* @param param1 first parameter
|
|
||||||
* @param param2 second parameter
|
|
||||||
* @param parameter3 third parameter
|
|
||||||
*/
|
|
||||||
template <typename T>
|
|
||||||
std::shared_ptr<std::string> long_function_with_many_parameters(std::shared_ptr<T>& param1, std::shared_ptr<std::string>& param2, bool parameter3) {
|
|
||||||
if(true) {
|
|
||||||
std::cout << "this even has some code." << std::endl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user