From 8a00ad572b66a81697e16ad2044c6f7fbf3ab33b Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Tue, 29 Jan 2019 10:15:35 -0500 Subject: [PATCH] Add namespaces, functions, and introduction page to docs. --- docs/Doxyfile | 11 ++++++----- docs/index.md | 3 +++ 2 files changed, 9 insertions(+), 5 deletions(-) create mode 100644 docs/index.md diff --git a/docs/Doxyfile b/docs/Doxyfile index b4856dbb..bad52dd5 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -457,7 +457,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -475,7 +475,7 @@ EXTRACT_PACKAGE = NO # included in the documentation. # The default value is: NO. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, @@ -592,7 +592,7 @@ INLINE_INFO = YES # name. If set to NO, the members will appear in declaration order. # The default value is: YES. -SORT_MEMBER_DOCS = YES +SORT_MEMBER_DOCS = NO # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member @@ -813,7 +813,8 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../src ../include +INPUT += index.md +INPUT += ../include # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1006,7 +1007,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = index.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..5a619343 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +This documentation is generated by Doxygen from docstrings in header files and might not include certain functions, macros, and structures that are present in header files. + +It is highly recommended to instead refer to the header files themselves as a true reference.