From 43cee897b004c2f47c34ff120ee8fa09adac30c0 Mon Sep 17 00:00:00 2001 From: redtide Date: Mon, 18 Nov 2019 00:22:06 +0100 Subject: [PATCH] Adapt doxygen configuration to recent changes --- .gitignore | 5 +++-- Doxyfile | 14 +++++++------- sfizz/sfizz.h | 5 +++++ 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 21cf0379..3c507867 100644 --- a/.gitignore +++ b/.gitignore @@ -23,9 +23,10 @@ clients/sfzprint # gh-pages unstaged files: -.bundle/ -Gemfile.lock _site/ +.bundle/ +api/ assets/ node_modules/ +Gemfile.lock yarn.lock diff --git a/Doxyfile b/Doxyfile index 50d43da2..e130133c 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ./docs/ +OUTPUT_DIRECTORY = . # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -458,7 +458,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -515,7 +515,7 @@ EXTRACT_ANON_NSPACES = NO # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. -HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set @@ -523,7 +523,7 @@ HIDE_UNDOC_MEMBERS = NO # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. -HIDE_UNDOC_CLASSES = NO +HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be @@ -702,7 +702,7 @@ SHOW_USED_FILES = NO # (if specified). # The default value is: YES. -SHOW_FILES = NO +SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the @@ -1105,7 +1105,7 @@ GENERATE_HTML = YES # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = doxy +HTML_OUTPUT = api # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). @@ -1286,7 +1286,7 @@ DOCSET_BUNDLE_ID = tools.sfz.sfizz # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_PUBLISHER_ID = tools.sfz +DOCSET_PUBLISHER_ID = tools.sfz.SFZTools # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. diff --git a/sfizz/sfizz.h b/sfizz/sfizz.h index 32ae9baf..e56a3c22 100644 --- a/sfizz/sfizz.h +++ b/sfizz/sfizz.h @@ -21,6 +21,11 @@ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/** + @file + @brief sfizz public API. +*/ + #pragma once #ifdef __cplusplus