From 6fa8a17fbb6a18ee7a25f5a2596d6f384e24107b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 9 Jun 2020 12:22:03 +0200 Subject: [PATCH] doc: move Doxyfiles out of the root. Those are useless for 90% of users, needlessly polluting the root directory. --- Doxyfile => doc/Doxyfile | 102 ++++++++++++------------- Doxyfile-mcss => doc/Doxyfile-mcss | 10 +-- Doxyfile-public => doc/Doxyfile-public | 8 +- 3 files changed, 60 insertions(+), 60 deletions(-) rename Doxyfile => doc/Doxyfile (97%) rename Doxyfile-mcss => doc/Doxyfile-mcss (97%) rename Doxyfile-public => doc/Doxyfile-public (97%) diff --git a/Doxyfile b/doc/Doxyfile similarity index 97% rename from Doxyfile rename to doc/Doxyfile index 47b8de95e..1e818ce52 100644 --- a/Doxyfile +++ b/doc/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 = build/doc +OUTPUT_DIRECTORY = ../build/doc # 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 @@ -160,10 +160,10 @@ FULL_PATH_NAMES = YES # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = ../magnum/src \ - ../magnum-plugins/src \ - ../magnum-integration/src \ - ../magnum-extras/src +STRIP_FROM_PATH = ../../magnum/src \ + ../../magnum-plugins/src \ + ../../magnum-integration/src \ + ../../magnum-extras/src # 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 @@ -172,10 +172,10 @@ STRIP_FROM_PATH = ../magnum/src \ # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = ../magnum/src \ - ../magnum-plugins/src \ - ../magnum-integration/src \ - ../magnum-extras/src +STRIP_FROM_INC_PATH = ../../magnum/src \ + ../../magnum-plugins/src \ + ../../magnum-integration/src \ + ../../magnum-extras/src # 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 @@ -914,24 +914,24 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src/Magnum \ - src/MagnumPlugins \ - src/Magnum/Audio/al-info.cpp \ - src/Magnum/MeshTools/sceneconverter.cpp \ - src/Magnum/Platform/gl-info.cpp \ - src/Magnum/Text/fontconverter.cpp \ - src/Magnum/TextureTools/distancefieldconverter.cpp \ - src/Magnum/Trade/imageconverter.cpp \ - doc/ \ - ../magnum-plugins/src/Magnum \ - ../magnum-plugins/src/MagnumPlugins \ - ../magnum-plugins/doc/ \ - ../magnum-integration/src/Magnum \ - ../magnum-integration/doc/ \ - ../magnum-examples/doc/ \ - ../magnum-extras/src/Magnum \ - ../magnum-extras/src/Magnum/Ui/ui-gallery.cpp \ - ../magnum-extras/doc/ +INPUT = ../src/Magnum \ + ../src/MagnumPlugins \ + ../src/Magnum/Audio/al-info.cpp \ + ../src/Magnum/MeshTools/sceneconverter.cpp \ + ../src/Magnum/Platform/gl-info.cpp \ + ../src/Magnum/Text/fontconverter.cpp \ + ../src/Magnum/TextureTools/distancefieldconverter.cpp \ + ../src/Magnum/Trade/imageconverter.cpp \ + . \ + ../../magnum-plugins/src/Magnum \ + ../../magnum-plugins/src/MagnumPlugins \ + ../../magnum-plugins/doc/ \ + ../../magnum-integration/src/Magnum \ + ../../magnum-integration/doc/ \ + ../../magnum-examples/doc/ \ + ../../magnum-extras/src/Magnum \ + ../../magnum-extras/src/Magnum/Ui/ui-gallery.cpp \ + ../../magnum-extras/doc/ # 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 @@ -975,7 +975,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = doc/snippets/ +EXCLUDE = snippets/ # 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 @@ -1010,14 +1010,14 @@ EXCLUDE_SYMBOLS = Magnum::*Implementation \ # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = doc/generated/ \ - doc/snippets/ \ - src/ \ - ../magnum-plugins/src/ \ - ../magnum-plugins/doc/snippets/ \ - ../magnum-examples/src/ \ - ../magnum-extras/doc/snippets/ \ - ../magnum-integration/doc/snippets/ +EXAMPLE_PATH = generated/ \ + snippets/ \ + ../src/ \ + ../../magnum-plugins/src/ \ + ../../magnum-plugins/doc/snippets/ \ + ../../magnum-examples/src/ \ + ../../magnum-extras/doc/snippets/ \ + ../../magnum-integration/doc/snippets/ # 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 @@ -1037,10 +1037,10 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = doc/ \ - doc/snippets/ \ - ../magnum-examples/doc \ - ../magnum-extras/doc +IMAGE_PATH = . \ + snippets/ \ + ../../magnum-examples/doc \ + ../../magnum-extras/doc # 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 @@ -2222,10 +2222,10 @@ SEARCH_INCLUDES = YES # preprocessor. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = src \ - ../magnum-plugins/src \ - ../magnum-extras/src \ - ../magnum-integration/src +INCLUDE_PATH = ../src \ + ../../magnum-plugins/src \ + ../../magnum-extras/src \ + ../../magnum-integration/src # 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 @@ -2288,14 +2288,14 @@ SKIP_FUNCTION_MACROS = YES # 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. -TAGFILES = ../corrade/build/doc/corrade.tag=../../../../corrade/build/doc/html \ - ../corrade/doc/stl.tag=http://en.cppreference.com/w/ +TAGFILES = ../../corrade/build/doc/corrade.tag=../../../../corrade/build/doc/html \ + ../../corrade/doc/stl.tag=http://en.cppreference.com/w/ # 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 # 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 # the class index. If set to NO, only the inherited external classes will be @@ -2536,10 +2536,10 @@ DOT_PATH = # command). # This tag requires that the tag HAVE_DOT is set to YES. -DOTFILE_DIRS = doc/ \ - ../magnum-plugins/doc \ - ../magnum-integration/doc \ - ../magnum-extras/doc +DOTFILE_DIRS = . \ + ../../magnum-plugins/doc \ + ../../magnum-integration/doc \ + ../../magnum-extras/doc # 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 diff --git a/Doxyfile-mcss b/doc/Doxyfile-mcss similarity index 97% rename from Doxyfile-mcss rename to doc/Doxyfile-mcss index 798c58258..48eeca82c 100644 --- a/Doxyfile-mcss +++ b/doc/Doxyfile-mcss @@ -2,15 +2,15 @@ ## 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 GENERATE_HTML = NO GENERATE_XML = YES XML_PROGRAMLISTING = NO XML_NS_MEMB_FILE_SCOPE = YES -GENERATE_TAGFILE = build/doc-mcss/magnum.tag -TAGFILES = ../corrade/build/doc-mcss/corrade.tag=../../../../corrade/build/doc-mcss/html \ - ../corrade/doc/stl.tag=http://en.cppreference.com/w/ +GENERATE_TAGFILE = ../build/doc-mcss/magnum.tag +TAGFILES = ../../corrade/build/doc-mcss/corrade.tag=../../../../corrade/build/doc-mcss/html \ + ../../corrade/doc/stl.tag=http://en.cppreference.com/w/ ## 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. @@ -111,7 +111,7 @@ HTML_EXTRA_STYLESHEET = \ ##! M_SEARCH_HELP = "

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 : or / suffix lists all members of given symbol or directory.

Use ↓ / ↑ to navigate through the list, Enter to go. Tab autocompletes common prefix, you can copy a link to the result using ⌘ L while ⌘ M produces a Markdown link.

" -##! M_FAVICON = doc/favicon.ico +##! M_FAVICON = favicon.ico ##! M_MAIN_PROJECT_URL = https://magnum.graphics/ ##! M_LINKS_NAVBAR1 = \ diff --git a/Doxyfile-public b/doc/Doxyfile-public similarity index 97% rename from Doxyfile-public rename to doc/Doxyfile-public index 38b7a5410..3c1bb1377 100644 --- a/Doxyfile-public +++ b/doc/Doxyfile-public @@ -3,10 +3,10 @@ ## Patches for the public docs. Hiding internal stuff, using a different ## stylesheet and relocating Corrade links to the public Corrade docs. -OUTPUT_DIRECTORY = build/doc-public/ -GENERATE_TAGFILE = build/doc-public/magnum.tag -TAGFILES = ../corrade/build/doc-public/corrade.tag=https://doc.magnum.graphics/corrade/ \ - ../corrade/doc/stl.tag=http://en.cppreference.com/w/ +OUTPUT_DIRECTORY = ../build/doc-public/ +GENERATE_TAGFILE = ../build/doc-public/magnum.tag +TAGFILES = ../../corrade/build/doc-public/corrade.tag=https://doc.magnum.graphics/corrade/ \ + ../../corrade/doc/stl.tag=http://en.cppreference.com/w/ ## 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