Commit 5f872595 authored by Micha Mueller's avatar Micha Mueller
Browse files

Minor improvements to doc/Doxyfile; remove previous lib/Doxyfile

parent 57dde4ee
...@@ -4,6 +4,8 @@ install/ ...@@ -4,6 +4,8 @@ install/
## Ignore DCDB generated documentation ## Ignore DCDB generated documentation
doc/html doc/html
doc/dcdb_documentation.html
doc/dox_stderr.txt
## Ignore object files and other binaries ## Ignore object files and other binaries
*.o *.o
......
...@@ -100,7 +100,7 @@ cleandeps: ...@@ -100,7 +100,7 @@ cleandeps:
cleandoc: cleandoc:
@echo "Cleaning doc/html..." @echo "Cleaning doc/html..."
@rm -rf doc/html @rm -rf doc/html && rm doc/dcdb_documentation.html && rm doc/dox_stderr.txt
cleanall: clean cleandeps cleandoc cleanall: clean cleandeps cleandoc
...@@ -117,7 +117,7 @@ mrproper: distclean ...@@ -117,7 +117,7 @@ mrproper: distclean
doc: doc:
@echo "Generating doxygen HTML documentation..." @echo "Generating doxygen HTML documentation..."
@cd doc/ && doxygen Doxyfile @cd doc/ && doxygen Doxyfile && ln -sf ./html/index.html ./dcdb_documentation.html
@echo "Generated docs into doc/html" @echo "Generated docs into doc/html"
all: check-cross-compile deps $(foreach s,$(SUB_DIRS),$(s)-build) all: check-cross-compile deps $(foreach s,$(SUB_DIRS),$(s)-build)
......
# Doxyfile 1.8.11 # DCDB Doxyfile
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project. # doxygen (www.doxygen.org) for a project.
...@@ -44,7 +44,7 @@ PROJECT_NUMBER = 0.3 ...@@ -44,7 +44,7 @@ PROJECT_NUMBER = 0.3
# for a project that appears at the top of each page and should give viewer a # 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. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Data Center DataBase" PROJECT_BRIEF = "DataCenter DataBase"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included # 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 # in the documentation. The maximum height of the logo should not exceed 55
...@@ -309,7 +309,7 @@ AUTOLINK_SUPPORT = YES ...@@ -309,7 +309,7 @@ AUTOLINK_SUPPORT = YES
# diagrams that involve STL classes more complete and accurate. # diagrams that involve STL classes more complete and accurate.
# The default value is: NO. # The default value is: NO.
BUILTIN_STL_SUPPORT = YES BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to # If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support. # enable parsing support.
...@@ -416,7 +416,7 @@ LOOKUP_CACHE_SIZE = 0 ...@@ -416,7 +416,7 @@ LOOKUP_CACHE_SIZE = 0
# normally produced when WARNINGS is set to YES. # normally produced when WARNINGS is set to YES.
# The default value is: NO. # 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 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation. # be included in the documentation.
...@@ -759,7 +759,7 @@ WARN_FORMAT = "$file:$line: $text" ...@@ -759,7 +759,7 @@ WARN_FORMAT = "$file:$line: $text"
# messages should be written. If left blank the output is written to standard # messages should be written. If left blank the output is written to standard
# error (stderr). # error (stderr).
WARN_LOGFILE = WARN_LOGFILE = dox_stderr.txt
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the input files # Configuration options related to the input files
...@@ -771,7 +771,7 @@ WARN_LOGFILE = ...@@ -771,7 +771,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = ./.. INPUT = ./../analytics ./../collectagent ./../common ./../dcdbpusher ./../lib ./../tools
# This tag can be used to specify the character encoding of the source files # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
...@@ -1179,7 +1179,7 @@ HTML_COLORSTYLE_GAMMA = 80 ...@@ -1179,7 +1179,7 @@ HTML_COLORSTYLE_GAMMA = 80
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO HTML_TIMESTAMP = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the # documentation will contain sections that can be hidden and shown after the
...@@ -2326,7 +2326,7 @@ DOT_IMAGE_FORMAT = png ...@@ -2326,7 +2326,7 @@ DOT_IMAGE_FORMAT = png
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO INTERACTIVE_SVG = YES
# The DOT_PATH tag can be used to specify the path where the dot tool can be # The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path. # found. If left blank, it is assumed the dot tool can be found in the path.
...@@ -2409,7 +2409,7 @@ DOT_TRANSPARENT = NO ...@@ -2409,7 +2409,7 @@ DOT_TRANSPARENT = NO
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO DOT_MULTI_TARGETS = YES
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated # explaining the meaning of the various boxes and arrows in the dot generated
......
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment