diff --git a/.gitignore b/.gitignore index 676ecee..dc92476 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ /build/ +/doc/ +/update_doc.sh *.xpi diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..9d16336 --- /dev/null +++ b/Doxyfile @@ -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 diff --git a/build_doc.sh b/build_doc.sh new file mode 100755 index 0000000..fb51945 --- /dev/null +++ b/build_doc.sh @@ -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