Added Doxygen config and script.

This commit is contained in:
tastytea 2019-07-27 22:30:31 +02:00
parent 514f88b0eb
commit 91cd922277
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
3 changed files with 35 additions and 0 deletions

2
.gitignore vendored
View File

@ -1,2 +1,4 @@
/build/
/doc/
/update_doc.sh
*.xpi

26
Doxyfile Normal file
View File

@ -0,0 +1,26 @@
# -*- mode: conf-unix -*-
PROJECT_NAME = "remwharead"
PROJECT_NUMBER = 0.0.0
INPUT = src/lib/ src/lib/export/
# EXAMPLE_PATH = examples/
EXAMPLE_RECURSIVE = YES
GENERATE_HTML = YES
HTML_OUTPUT = doc/html
GENERATE_LATEX = NO
ALLOW_UNICODE_NAMES = YES
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
MARKDOWN_SUPPORT = YES
AUTOLINK_SUPPORT = YES
INLINE_SIMPLE_STRUCTS = NO
QUIET = NO
WARNINGS = YES
BUILTIN_STL_SUPPORT = YES
VERBATIM_HEADERS = YES
INLINE_SOURCES = YES
SEARCHENGINE = YES

7
build_doc.sh Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
if [[ -f Doxyfile ]]; then
mkdir -p doc
(doxygen -s -g - && cat Doxyfile && echo -n "PROJECT_NUMBER = " &&
grep -Eo '[0-9]+.[0-9]+.[0-9]+$' CMakeLists.txt) | doxygen -
fi