From 7e211b4e77601447d7db47707e44188bc0bbf8fe Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Sat, 19 Sep 2015 16:01:39 +0200 Subject: [PATCH] updated Doxygen configuration --- Doxyfile | 18 +++++++++--------- documentation/.gitignore | 2 +- documentation/{ => theme}/header.html | 0 documentation/{ => theme}/layout.xml | 0 documentation/{ => theme}/style.css | 0 5 files changed, 10 insertions(+), 10 deletions(-) rename documentation/{ => theme}/header.html (100%) rename documentation/{ => theme}/layout.xml (100%) rename documentation/{ => theme}/style.css (100%) diff --git a/Doxyfile b/Doxyfile index e25b53872..f5725561e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -44,7 +44,7 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "Connecting realtime powergrid simulators via IP/UDP" +PROJECT_BRIEF = "Connecting real-time power grid simulation equipment" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 @@ -684,7 +684,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = documentation/layout.xml +LAYOUT_FILE = documentation/theme/layout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -705,7 +705,7 @@ CITE_BIB_FILES = # messages are off. # The default value is: NO. -QUIET = NO +QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES @@ -753,7 +753,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = documentation/warnings.log #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -844,7 +844,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = etc/ +EXAMPLE_PATH = server/etc/ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -858,7 +858,7 @@ EXAMPLE_PATTERNS = # irrespective of the value of the RECURSIVE tag. # The default value is: NO. -EXAMPLE_RECURSIVE = NO +EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the @@ -1087,7 +1087,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = documentation/header.html +HTML_HEADER = documentation/theme/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1122,7 +1122,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = documentation/style.css +HTML_EXTRA_STYLESHEET = documentation/theme/style.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1596,7 +1596,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/documentation/.gitignore b/documentation/.gitignore index 6cbe644cc..4367453f3 100644 --- a/documentation/.gitignore +++ b/documentation/.gitignore @@ -1,3 +1,3 @@ html/ -latex/ doxygen_sqlite3.db +warnings.log diff --git a/documentation/header.html b/documentation/theme/header.html similarity index 100% rename from documentation/header.html rename to documentation/theme/header.html diff --git a/documentation/layout.xml b/documentation/theme/layout.xml similarity index 100% rename from documentation/layout.xml rename to documentation/theme/layout.xml diff --git a/documentation/style.css b/documentation/theme/style.css similarity index 100% rename from documentation/style.css rename to documentation/theme/style.css