Skip to content
Snippets Groups Projects
Commit 42d67bef authored by mhamilt7's avatar mhamilt7
Browse files

add markdown and styling notes

parent 0221f3a1
No related branches found
No related tags found
3 merge requests!4Joe merge,!3Doxygen Documentation,!2Docs
......@@ -79,3 +79,33 @@ run in the command line as
cd path/to/repo/
doxygen Doxyfile
```
### Markdown
[Doxygen supports Markdown!](http://www.doxygen.nl/manual/markdown.html) So you can use markdown in comment blocks if necessary.
In the doxygen file you can also point the frontpage to a `.md` file.
```make
USE_MDFILE_AS_MAINPAGE =
```
This will populate the mainpage with html from the specified markdown file.
### Custom Output
You can specify a html header, footer and custom css files. The easiest approach would be to generate these first
```sh
doxygen -w html header.html footer.html customdoxygen.css
```
then edit them as necessary.
Change these options in the Doxyfile
```make
HTML_HEADER = header.html
HTML_FOOTER = footer.html
HTML_EXTRA_STYLESHEET = my_customdoxygen.css
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment