Browse Source

doc: move Doxyfiles out of the root.

Those are useless for 90% of users, needlessly polluting the root
directory.
pull/454/head
Vladimír Vondruš 6 years ago
parent
commit
6fa8a17fbb
  1. 102
      doc/Doxyfile
  2. 10
      doc/Doxyfile-mcss
  3. 8
      doc/Doxyfile-public

102
Doxyfile → doc/Doxyfile

@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = build/doc OUTPUT_DIRECTORY = ../build/doc
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # 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 # directories (in 2 levels) under the output directory of each output format and
@ -160,10 +160,10 @@ FULL_PATH_NAMES = YES
# will be relative from the directory where doxygen is started. # will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES. # This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH = ../magnum/src \ STRIP_FROM_PATH = ../../magnum/src \
../magnum-plugins/src \ ../../magnum-plugins/src \
../magnum-integration/src \ ../../magnum-integration/src \
../magnum-extras/src ../../magnum-extras/src
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which # path mentioned in the documentation of a class, which tells the reader which
@ -172,10 +172,10 @@ STRIP_FROM_PATH = ../magnum/src \
# specify the list of include paths that are normally passed to the compiler # specify the list of include paths that are normally passed to the compiler
# using the -I flag. # using the -I flag.
STRIP_FROM_INC_PATH = ../magnum/src \ STRIP_FROM_INC_PATH = ../../magnum/src \
../magnum-plugins/src \ ../../magnum-plugins/src \
../magnum-integration/src \ ../../magnum-integration/src \
../magnum-extras/src ../../magnum-extras/src
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't # less readable) file names. This can be useful is your file systems doesn't
@ -914,24 +914,24 @@ 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 = src/Magnum \ INPUT = ../src/Magnum \
src/MagnumPlugins \ ../src/MagnumPlugins \
src/Magnum/Audio/al-info.cpp \ ../src/Magnum/Audio/al-info.cpp \
src/Magnum/MeshTools/sceneconverter.cpp \ ../src/Magnum/MeshTools/sceneconverter.cpp \
src/Magnum/Platform/gl-info.cpp \ ../src/Magnum/Platform/gl-info.cpp \
src/Magnum/Text/fontconverter.cpp \ ../src/Magnum/Text/fontconverter.cpp \
src/Magnum/TextureTools/distancefieldconverter.cpp \ ../src/Magnum/TextureTools/distancefieldconverter.cpp \
src/Magnum/Trade/imageconverter.cpp \ ../src/Magnum/Trade/imageconverter.cpp \
doc/ \ . \
../magnum-plugins/src/Magnum \ ../../magnum-plugins/src/Magnum \
../magnum-plugins/src/MagnumPlugins \ ../../magnum-plugins/src/MagnumPlugins \
../magnum-plugins/doc/ \ ../../magnum-plugins/doc/ \
../magnum-integration/src/Magnum \ ../../magnum-integration/src/Magnum \
../magnum-integration/doc/ \ ../../magnum-integration/doc/ \
../magnum-examples/doc/ \ ../../magnum-examples/doc/ \
../magnum-extras/src/Magnum \ ../../magnum-extras/src/Magnum \
../magnum-extras/src/Magnum/Ui/ui-gallery.cpp \ ../../magnum-extras/src/Magnum/Ui/ui-gallery.cpp \
../magnum-extras/doc/ ../../magnum-extras/doc/
# 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
@ -975,7 +975,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is # Note that relative paths are relative to the directory from which doxygen is
# run. # run.
EXCLUDE = doc/snippets/ EXCLUDE = snippets/
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded # directories that are symbolic links (a Unix file system feature) are excluded
@ -1010,14 +1010,14 @@ EXCLUDE_SYMBOLS = Magnum::*Implementation \
# that contain example code fragments that are included (see the \include # that contain example code fragments that are included (see the \include
# command). # command).
EXAMPLE_PATH = doc/generated/ \ EXAMPLE_PATH = generated/ \
doc/snippets/ \ snippets/ \
src/ \ ../src/ \
../magnum-plugins/src/ \ ../../magnum-plugins/src/ \
../magnum-plugins/doc/snippets/ \ ../../magnum-plugins/doc/snippets/ \
../magnum-examples/src/ \ ../../magnum-examples/src/ \
../magnum-extras/doc/snippets/ \ ../../magnum-extras/doc/snippets/ \
../magnum-integration/doc/snippets/ ../../magnum-integration/doc/snippets/
# If the value of the EXAMPLE_PATH tag contains directories, you can use the # 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 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@ -1037,10 +1037,10 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the # that contain images that are to be included in the documentation (see the
# \image command). # \image command).
IMAGE_PATH = doc/ \ IMAGE_PATH = . \
doc/snippets/ \ snippets/ \
../magnum-examples/doc \ ../../magnum-examples/doc \
../magnum-extras/doc ../../magnum-extras/doc
# The INPUT_FILTER tag can be used to specify a program that doxygen should # The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program # invoke to filter for each input file. Doxygen will invoke the filter program
@ -2222,10 +2222,10 @@ SEARCH_INCLUDES = YES
# preprocessor. # preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES. # This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH = src \ INCLUDE_PATH = ../src \
../magnum-plugins/src \ ../../magnum-plugins/src \
../magnum-extras/src \ ../../magnum-extras/src \
../magnum-integration/src ../../magnum-integration/src
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the # patterns (like *.h and *.hpp) to filter out the header-files in the
@ -2288,14 +2288,14 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is # the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here. # run, you must also specify the path to the tagfile here.
TAGFILES = ../corrade/build/doc/corrade.tag=../../../../corrade/build/doc/html \ TAGFILES = ../../corrade/build/doc/corrade.tag=../../../../corrade/build/doc/html \
../corrade/doc/stl.tag=http://en.cppreference.com/w/ ../../corrade/doc/stl.tag=http://en.cppreference.com/w/
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to # tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files. # external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = build/doc/magnum.tag GENERATE_TAGFILE = ../build/doc/magnum.tag
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be # the class index. If set to NO, only the inherited external classes will be
@ -2536,10 +2536,10 @@ DOT_PATH =
# command). # command).
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS = doc/ \ DOTFILE_DIRS = . \
../magnum-plugins/doc \ ../../magnum-plugins/doc \
../magnum-integration/doc \ ../../magnum-integration/doc \
../magnum-extras/doc ../../magnum-extras/doc
# The MSCFILE_DIRS tag can be used to specify one or more directories that # The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile # contain msc files that are included in the documentation (see the \mscfile

10
Doxyfile-mcss → doc/Doxyfile-mcss

@ -2,15 +2,15 @@
## Patches for the m.css-generated docs. Just need to generate XML, that's it. ## Patches for the m.css-generated docs. Just need to generate XML, that's it.
OUTPUT_DIRECTORY = build/doc-mcss/ OUTPUT_DIRECTORY = ../build/doc-mcss/
PROJECT_BRIEF = C++ docs PROJECT_BRIEF = C++ docs
GENERATE_HTML = NO GENERATE_HTML = NO
GENERATE_XML = YES GENERATE_XML = YES
XML_PROGRAMLISTING = NO XML_PROGRAMLISTING = NO
XML_NS_MEMB_FILE_SCOPE = YES XML_NS_MEMB_FILE_SCOPE = YES
GENERATE_TAGFILE = build/doc-mcss/magnum.tag GENERATE_TAGFILE = ../build/doc-mcss/magnum.tag
TAGFILES = ../corrade/build/doc-mcss/corrade.tag=../../../../corrade/build/doc-mcss/html \ TAGFILES = ../../corrade/build/doc-mcss/corrade.tag=../../../../corrade/build/doc-mcss/html \
../corrade/doc/stl.tag=http://en.cppreference.com/w/ ../../corrade/doc/stl.tag=http://en.cppreference.com/w/
## Added m.css-specific @m_* commands and all the GL/AL/extension links are ## Added m.css-specific @m_* commands and all the GL/AL/extension links are
## marked with m-doc-external CSS class to avoid ugly underline. ## marked with m-doc-external CSS class to avoid ugly underline.
@ -111,7 +111,7 @@ HTML_EXTRA_STYLESHEET = \
##! M_SEARCH_HELP = "<p class="m-noindent">Search for symbols, directories, files, pages, OpenGL, GLSL, Vulkan and OpenAL APIs. You can omit any prefix from the symbol or file path; adding a <code>:</code> or <code>/</code> suffix lists all members of given symbol or directory.</p> <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span> / <span class="m-label m-dim">&uarr;</span> to navigate through the list, <span class="m-label m-dim">Enter</span> to go. <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> produces a Markdown link.</p>" ##! M_SEARCH_HELP = "<p class="m-noindent">Search for symbols, directories, files, pages, OpenGL, GLSL, Vulkan and OpenAL APIs. You can omit any prefix from the symbol or file path; adding a <code>:</code> or <code>/</code> suffix lists all members of given symbol or directory.</p> <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span> / <span class="m-label m-dim">&uarr;</span> to navigate through the list, <span class="m-label m-dim">Enter</span> to go. <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> produces a Markdown link.</p>"
##! M_FAVICON = doc/favicon.ico ##! M_FAVICON = favicon.ico
##! M_MAIN_PROJECT_URL = https://magnum.graphics/ ##! M_MAIN_PROJECT_URL = https://magnum.graphics/
##! M_LINKS_NAVBAR1 = \ ##! M_LINKS_NAVBAR1 = \

8
Doxyfile-public → doc/Doxyfile-public

@ -3,10 +3,10 @@
## Patches for the public docs. Hiding internal stuff, using a different ## Patches for the public docs. Hiding internal stuff, using a different
## stylesheet and relocating Corrade links to the public Corrade docs. ## stylesheet and relocating Corrade links to the public Corrade docs.
OUTPUT_DIRECTORY = build/doc-public/ OUTPUT_DIRECTORY = ../build/doc-public/
GENERATE_TAGFILE = build/doc-public/magnum.tag GENERATE_TAGFILE = ../build/doc-public/magnum.tag
TAGFILES = ../corrade/build/doc-public/corrade.tag=https://doc.magnum.graphics/corrade/ \ TAGFILES = ../../corrade/build/doc-public/corrade.tag=https://doc.magnum.graphics/corrade/ \
../corrade/doc/stl.tag=http://en.cppreference.com/w/ ../../corrade/doc/stl.tag=http://en.cppreference.com/w/
## No need to expose TODO list or bug list in public docs. Aliases copied from ## No need to expose TODO list or bug list in public docs. Aliases copied from
## Doxyfile-mcss, with @todoc changed to be just an alias to @todo so it also ## Doxyfile-mcss, with @todoc changed to be just an alias to @todo so it also
Loading…
Cancel
Save