From: Vladimír Vondruš Date: Mon, 11 Dec 2017 10:15:08 +0000 (+0100) Subject: doxygen: make it possible to not display Doxygen version in output. X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=e9b78327fc3d51511d09684c69e6648de4333767;p=blog.git doxygen: make it possible to not display Doxygen version in output. Makes testing on Other People Machines actually possible. --- diff --git a/doc/doxygen.rst b/doc/doxygen.rst index 1ed4b6c0..b3914771 100644 --- a/doc/doxygen.rst +++ b/doc/doxygen.rst @@ -249,6 +249,9 @@ Variable Description :ini:`M_EXPAND_INNER_TYPES` Whether to expand inner types (e.g. a class inside a class) in the symbol tree. If not set, ``NO`` is used. +:ini:`M_SHOW_DOXYGEN_VERSION` Show Doxygen version in the footer. If not + set, ``YES`` is used; useful to disable for + output verification. =================================== ======================================= Note that namespace, directory and page lists are always fully expanded as diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py index fc39e9b9..26d39d3a 100755 --- a/doxygen/dox2html5.py +++ b/doxygen/dox2html5.py @@ -1543,7 +1543,8 @@ def parse_doxyfile(state: State, doxyfile, config = None): 'M_CLASS_TREE_EXPAND_LEVELS': ['1'], 'M_FILE_TREE_EXPAND_LEVELS': ['1'], 'M_EXPAND_INNER_TYPES': ['NO'], - 'M_THEME_COLOR': ['#22272e'] + 'M_THEME_COLOR': ['#22272e'], + 'M_SHOW_DOXYGEN_VERSION': ['YES'] } def parse_value(var): @@ -1627,7 +1628,8 @@ def parse_doxyfile(state: State, doxyfile, config = None): if i in config: state.doxyfile[i] = int(' '.join(config[i])) # Boolean values that we want - for i in ['M_EXPAND_INNER_TYPES']: + for i in ['M_EXPAND_INNER_TYPES', + 'M_SHOW_DOXYGEN_VERSION']: if i in config: state.doxyfile[i] = ' '.join(config[i]) == 'YES' # List values that we want. Drop empty lines. diff --git a/doxygen/templates/base.html b/doxygen/templates/base.html index 1c5ea732..d7d632fa 100644 --- a/doxygen/templates/base.html +++ b/doxygen/templates/base.html @@ -48,7 +48,7 @@
-

{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %}. Created by Doxygen {{ DOXYGEN_VERSION }} and m.css.

+

{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %}. Created by Doxygen{% if M_SHOW_DOXYGEN_VERSION %} {{ DOXYGEN_VERSION }}{% endif %} and m.css.

diff --git a/doxygen/test/compound_detailed/Doxyfile b/doxygen/test/compound_detailed/Doxyfile index beb4a79a..29eb753c 100644 --- a/doxygen/test/compound_detailed/Doxyfile +++ b/doxygen/test/compound_detailed/Doxyfile @@ -4,3 +4,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/compound_detailed/File_8h.html b/doxygen/test/compound_detailed/File_8h.html index 5870b7d4..3d76117f 100644 --- a/doxygen/test/compound_detailed/File_8h.html +++ b/doxygen/test/compound_detailed/File_8h.html @@ -152,7 +152,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/namespaceEno.html b/doxygen/test/compound_detailed/namespaceEno.html index 132ae50d..e48ce60b 100644 --- a/doxygen/test/compound_detailed/namespaceEno.html +++ b/doxygen/test/compound_detailed/namespaceEno.html @@ -106,7 +106,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/namespaceFoo.html b/doxygen/test/compound_detailed/namespaceFoo.html index 89a8fc80..a20245f4 100644 --- a/doxygen/test/compound_detailed/namespaceFoo.html +++ b/doxygen/test/compound_detailed/namespaceFoo.html @@ -170,7 +170,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/namespaceNamee.html b/doxygen/test/compound_detailed/namespaceNamee.html index 02125b77..d0dd6d97 100644 --- a/doxygen/test/compound_detailed/namespaceNamee.html +++ b/doxygen/test/compound_detailed/namespaceNamee.html @@ -45,7 +45,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/namespaceType.html b/doxygen/test/compound_detailed/namespaceType.html index aab8ad7a..8de1fbd8 100644 --- a/doxygen/test/compound_detailed/namespaceType.html +++ b/doxygen/test/compound_detailed/namespaceType.html @@ -109,7 +109,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/namespaceVar.html b/doxygen/test/compound_detailed/namespaceVar.html index e9f042fd..b16cac0b 100644 --- a/doxygen/test/compound_detailed/namespaceVar.html +++ b/doxygen/test/compound_detailed/namespaceVar.html @@ -71,7 +71,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/namespaceWarning.html b/doxygen/test/compound_detailed/namespaceWarning.html index 93b73cca..95ce32cf 100644 --- a/doxygen/test/compound_detailed/namespaceWarning.html +++ b/doxygen/test/compound_detailed/namespaceWarning.html @@ -73,7 +73,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/structTemplate.html b/doxygen/test/compound_detailed/structTemplate.html index 037ced2e..44052a8a 100644 --- a/doxygen/test/compound_detailed/structTemplate.html +++ b/doxygen/test/compound_detailed/structTemplate.html @@ -217,7 +217,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/structTemplateWarning.html b/doxygen/test/compound_detailed/structTemplateWarning.html index 6194a1c4..0f6175c0 100644 --- a/doxygen/test/compound_detailed/structTemplateWarning.html +++ b/doxygen/test/compound_detailed/structTemplateWarning.html @@ -47,7 +47,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_detailed/structTemplate_3_01void_01_4.html b/doxygen/test/compound_detailed/structTemplate_3_01void_01_4.html index 69f4fcf5..1f245529 100644 --- a/doxygen/test/compound_detailed/structTemplate_3_01void_01_4.html +++ b/doxygen/test/compound_detailed/structTemplate_3_01void_01_4.html @@ -83,7 +83,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/Class_8h.html b/doxygen/test/compound_listing/Class_8h.html index b81e1cda..b4f60544 100644 --- a/doxygen/test/compound_listing/Class_8h.html +++ b/doxygen/test/compound_listing/Class_8h.html @@ -87,7 +87,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/Doxyfile b/doxygen/test/compound_listing/Doxyfile index 09aa151a..b772c0bb 100644 --- a/doxygen/test/compound_listing/Doxyfile +++ b/doxygen/test/compound_listing/Doxyfile @@ -8,3 +8,4 @@ GENERATE_LATEX = NO GENERATE_XML = YES M_FILE_TREE_EXPAND_LEVELS = 2 +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/compound_listing/File_8h.html b/doxygen/test/compound_listing/File_8h.html index bd32e51e..bacab9ff 100644 --- a/doxygen/test/compound_listing/File_8h.html +++ b/doxygen/test/compound_listing/File_8h.html @@ -104,7 +104,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/annotated.html b/doxygen/test/compound_listing/annotated.html index 7cd146aa..d03a150f 100644 --- a/doxygen/test/compound_listing/annotated.html +++ b/doxygen/test/compound_listing/annotated.html @@ -88,7 +88,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html b/doxygen/test/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html index 29267580..3959daeb 100644 --- a/doxygen/test/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html +++ b/doxygen/test/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html @@ -266,7 +266,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/dir_4b0d5f8864bf89936129251a2d32609b.html b/doxygen/test/compound_listing/dir_4b0d5f8864bf89936129251a2d32609b.html index f49a5207..7e333a05 100644 --- a/doxygen/test/compound_listing/dir_4b0d5f8864bf89936129251a2d32609b.html +++ b/doxygen/test/compound_listing/dir_4b0d5f8864bf89936129251a2d32609b.html @@ -72,7 +72,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/dir_bbe5918fe090eee9db2d9952314b6754.html b/doxygen/test/compound_listing/dir_bbe5918fe090eee9db2d9952314b6754.html index 476d8a4b..57e28df4 100644 --- a/doxygen/test/compound_listing/dir_bbe5918fe090eee9db2d9952314b6754.html +++ b/doxygen/test/compound_listing/dir_bbe5918fe090eee9db2d9952314b6754.html @@ -64,7 +64,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/files.html b/doxygen/test/compound_listing/files.html index 38971ccf..72d3656a 100644 --- a/doxygen/test/compound_listing/files.html +++ b/doxygen/test/compound_listing/files.html @@ -79,7 +79,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/namespaceAnother.html b/doxygen/test/compound_listing/namespaceAnother.html index 84cd77c7..a84c2693 100644 --- a/doxygen/test/compound_listing/namespaceAnother.html +++ b/doxygen/test/compound_listing/namespaceAnother.html @@ -44,7 +44,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/namespaceRoot_1_1Directory.html b/doxygen/test/compound_listing/namespaceRoot_1_1Directory.html index 6e8792df..ce4ac51c 100644 --- a/doxygen/test/compound_listing/namespaceRoot_1_1Directory.html +++ b/doxygen/test/compound_listing/namespaceRoot_1_1Directory.html @@ -142,7 +142,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/namespaces.html b/doxygen/test/compound_listing/namespaces.html index ac512a22..bdab3cf4 100644 --- a/doxygen/test/compound_listing/namespaces.html +++ b/doxygen/test/compound_listing/namespaces.html @@ -72,7 +72,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/page-no-toc.html b/doxygen/test/compound_listing/page-no-toc.html index ce38c092..1054655a 100644 --- a/doxygen/test/compound_listing/page-no-toc.html +++ b/doxygen/test/compound_listing/page-no-toc.html @@ -46,7 +46,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/compound_listing/page-toc.html b/doxygen/test/compound_listing/page-toc.html index 016da4bd..95a50961 100644 --- a/doxygen/test/compound_listing/page-toc.html +++ b/doxygen/test/compound_listing/page-toc.html @@ -64,7 +64,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_blocks/Doxyfile b/doxygen/test/contents_blocks/Doxyfile index d8d89a97..d64a2386 100644 --- a/doxygen/test/contents_blocks/Doxyfile +++ b/doxygen/test/contents_blocks/Doxyfile @@ -3,3 +3,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/contents_blocks/index.html b/doxygen/test/contents_blocks/index.html index f57c09c6..1a602dc0 100644 --- a/doxygen/test/contents_blocks/index.html +++ b/doxygen/test/contents_blocks/index.html @@ -48,7 +48,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_blocks/todo.html b/doxygen/test/contents_blocks/todo.html index a31416aa..e43f3b2d 100644 --- a/doxygen/test/contents_blocks/todo.html +++ b/doxygen/test/contents_blocks/todo.html @@ -46,7 +46,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_code/Doxyfile b/doxygen/test/contents_code/Doxyfile index 60356fdc..a316231b 100644 --- a/doxygen/test/contents_code/Doxyfile +++ b/doxygen/test/contents_code/Doxyfile @@ -4,3 +4,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/contents_code/index.html b/doxygen/test/contents_code/index.html index f52c31d6..53b29554 100644 --- a/doxygen/test/contents_code/index.html +++ b/doxygen/test/contents_code/index.html @@ -53,7 +53,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_code/warnings.html b/doxygen/test/contents_code/warnings.html index 21bd1f40..f8af16be 100644 --- a/doxygen/test/contents_code/warnings.html +++ b/doxygen/test/contents_code/warnings.html @@ -49,7 +49,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_image/Doxyfile b/doxygen/test/contents_image/Doxyfile index 0cd61da9..c366f1b5 100644 --- a/doxygen/test/contents_image/Doxyfile +++ b/doxygen/test/contents_image/Doxyfile @@ -4,3 +4,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/contents_image/index.html b/doxygen/test/contents_image/index.html index b914e0d1..37a8111c 100644 --- a/doxygen/test/contents_image/index.html +++ b/doxygen/test/contents_image/index.html @@ -46,7 +46,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_image/warnings.html b/doxygen/test/contents_image/warnings.html index f624aa2f..460e8846 100644 --- a/doxygen/test/contents_image/warnings.html +++ b/doxygen/test/contents_image/warnings.html @@ -46,7 +46,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_math/Doxyfile b/doxygen/test/contents_math/Doxyfile index d8d89a97..d64a2386 100644 --- a/doxygen/test/contents_math/Doxyfile +++ b/doxygen/test/contents_math/Doxyfile @@ -3,3 +3,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/contents_math/index.html b/doxygen/test/contents_math/index.html index da6c8059..fecd181e 100644 --- a/doxygen/test/contents_math/index.html +++ b/doxygen/test/contents_math/index.html @@ -98,7 +98,7 @@ $ \hat q $
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_tagfile/Doxyfile b/doxygen/test/contents_tagfile/Doxyfile index e361ae23..995ef6b3 100644 --- a/doxygen/test/contents_tagfile/Doxyfile +++ b/doxygen/test/contents_tagfile/Doxyfile @@ -4,3 +4,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/contents_tagfile/index.html b/doxygen/test/contents_tagfile/index.html index 5973d184..bea3f042 100644 --- a/doxygen/test/contents_tagfile/index.html +++ b/doxygen/test/contents_tagfile/index.html @@ -46,7 +46,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_typography/Doxyfile b/doxygen/test/contents_typography/Doxyfile index d8d89a97..d64a2386 100644 --- a/doxygen/test/contents_typography/Doxyfile +++ b/doxygen/test/contents_typography/Doxyfile @@ -3,3 +3,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/contents_typography/index.html b/doxygen/test/contents_typography/index.html index 89ebeac7..7b9d0506 100644 --- a/doxygen/test/contents_typography/index.html +++ b/doxygen/test/contents_typography/index.html @@ -47,7 +47,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/contents_typography/warnings.html b/doxygen/test/contents_typography/warnings.html index acc9fbd0..dd89cec6 100644 --- a/doxygen/test/contents_typography/warnings.html +++ b/doxygen/test/contents_typography/warnings.html @@ -46,7 +46,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/page_duplicated_brief/Doxyfile b/doxygen/test/page_duplicated_brief/Doxyfile index d8d89a97..d64a2386 100644 --- a/doxygen/test/page_duplicated_brief/Doxyfile +++ b/doxygen/test/page_duplicated_brief/Doxyfile @@ -3,3 +3,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/page_duplicated_brief/page-a.html b/doxygen/test/page_duplicated_brief/page-a.html index fbba0521..64df30e8 100644 --- a/doxygen/test/page_duplicated_brief/page-a.html +++ b/doxygen/test/page_duplicated_brief/page-a.html @@ -47,7 +47,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/page_duplicated_brief/page-b.html b/doxygen/test/page_duplicated_brief/page-b.html index 19faf697..429c5d2c 100644 --- a/doxygen/test/page_duplicated_brief/page-b.html +++ b/doxygen/test/page_duplicated_brief/page-b.html @@ -47,7 +47,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/page_order/Doxyfile b/doxygen/test/page_order/Doxyfile index b928f4c1..772e1b92 100644 --- a/doxygen/test/page_order/Doxyfile +++ b/doxygen/test/page_order/Doxyfile @@ -4,3 +4,5 @@ QUIET = YES GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES + +M_SHOW_DOXYGEN_VERSION = NO diff --git a/doxygen/test/page_order/pages.html b/doxygen/test/page_order/pages.html index 7e20e86a..4560f310 100644 --- a/doxygen/test/page_order/pages.html +++ b/doxygen/test/page_order/pages.html @@ -70,7 +70,7 @@
-

My Project. Created by Doxygen 1.8.14 and m.css.

+

My Project. Created by Doxygen and m.css.

diff --git a/doxygen/test/test_doxyfile.py b/doxygen/test/test_doxyfile.py index 862f5961..4d2214a5 100644 --- a/doxygen/test/test_doxyfile.py +++ b/doxygen/test/test_doxyfile.py @@ -13,6 +13,7 @@ class Doxyfile(unittest.TestCase): 'M_CLASS_TREE_EXPAND_LEVELS': 1, 'M_EXPAND_INNER_TYPES': False, 'M_FILE_TREE_EXPAND_LEVELS': 1, + 'M_SHOW_DOXYGEN_VERSION': True, 'M_THEME_COLOR': '#22272e', 'OUTPUT_DIRECTORY': '', 'PROJECT_BRIEF': 'is cool',