From 8160d8479b8cadb5985c8c6e6d5ff8e76fe26d77 Mon Sep 17 00:00:00 2001 From: albert-github Date: Tue, 24 Nov 2020 11:05:55 +0100 Subject: Have build of doxygen documentation fail on warnings. Currently when running doxygen to create its documentation no error is given when a warning is generated, so the warning might go unnoticed. By setting `WARN_AS_ERROR = YES` the generation will stop and when build on CI systems a build also fails --- doc/Doxyfile | 1 + examples/afterdoc.cfg | 1 + examples/author.cfg | 1 + examples/autolink.cfg | 1 + examples/class.cfg | 1 + examples/define.cfg | 1 + examples/diagrams.cfg | 1 + examples/docstring.cfg | 1 + examples/enum.cfg | 1 + examples/example.cfg | 1 + examples/file.cfg | 1 + examples/func.cfg | 1 + examples/group.cfg | 1 + examples/include.cfg | 1 + examples/javadoc-banner.cfg | 1 + examples/jdstyle.cfg | 1 + examples/manual.cfg | 1 + examples/memgrp.cfg | 1 + examples/mux.cfg | 1 + examples/overload.cfg | 1 + examples/page.cfg | 1 + examples/par.cfg | 1 + examples/pyexample.cfg | 1 + examples/qtstyle.cfg | 1 + examples/relates.cfg | 1 + examples/restypedef.cfg | 1 + examples/structcmd.cfg | 1 + examples/tag.cfg | 1 + examples/templ.cfg | 1 + 29 files changed, 29 insertions(+) diff --git a/doc/Doxyfile b/doc/Doxyfile index bd4a11f..c67eec5 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -57,3 +57,4 @@ ALIASES += forceNewPage="\latexonly \newpage \endlatexonly" LATEX_BATCHMODE = YES LATEX_EXTRA_STYLESHEET = manual.sty LATEX_EMOJI_DIRECTORY = ../doc +WARN_AS_ERROR = YES diff --git a/examples/afterdoc.cfg b/examples/afterdoc.cfg index 0542929..a4d4610 100644 --- a/examples/afterdoc.cfg +++ b/examples/afterdoc.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/author.cfg b/examples/author.cfg index 2fafbfe..3a9c017 100644 --- a/examples/author.cfg +++ b/examples/author.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/autolink.cfg b/examples/autolink.cfg index 68e5192..eeaebbc 100644 --- a/examples/autolink.cfg +++ b/examples/autolink.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/class.cfg b/examples/class.cfg index 5d75373..ee99294 100644 --- a/examples/class.cfg +++ b/examples/class.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/define.cfg b/examples/define.cfg index 61c0f52..3faa76f 100644 --- a/examples/define.cfg +++ b/examples/define.cfg @@ -12,3 +12,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/diagrams.cfg b/examples/diagrams.cfg index c2e637d..6b47c60 100644 --- a/examples/diagrams.cfg +++ b/examples/diagrams.cfg @@ -15,3 +15,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/docstring.cfg b/examples/docstring.cfg index 60b089e..e5ddb39 100644 --- a/examples/docstring.cfg +++ b/examples/docstring.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/enum.cfg b/examples/enum.cfg index e5540bd..75e6f15 100644 --- a/examples/enum.cfg +++ b/examples/enum.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/example.cfg b/examples/example.cfg index 22266d4..32aaeac 100644 --- a/examples/example.cfg +++ b/examples/example.cfg @@ -12,3 +12,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/file.cfg b/examples/file.cfg index ef67ae6..e802b85 100644 --- a/examples/file.cfg +++ b/examples/file.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/func.cfg b/examples/func.cfg index 2f455d9..6286e3d 100644 --- a/examples/func.cfg +++ b/examples/func.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/group.cfg b/examples/group.cfg index 83911b8..936f2bc 100644 --- a/examples/group.cfg +++ b/examples/group.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/include.cfg b/examples/include.cfg index abaecc6..1b4ba5b 100644 --- a/examples/include.cfg +++ b/examples/include.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/javadoc-banner.cfg b/examples/javadoc-banner.cfg index d650dbc..0e5d55a 100644 --- a/examples/javadoc-banner.cfg +++ b/examples/javadoc-banner.cfg @@ -13,3 +13,4 @@ SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES EXTRACT_ALL = YES +WARN_AS_ERROR = YES diff --git a/examples/jdstyle.cfg b/examples/jdstyle.cfg index d94089d..838215c 100644 --- a/examples/jdstyle.cfg +++ b/examples/jdstyle.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/manual.cfg b/examples/manual.cfg index 07040d9..e293a29 100644 --- a/examples/manual.cfg +++ b/examples/manual.cfg @@ -16,3 +16,4 @@ REFERENCES_RELATION = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/memgrp.cfg b/examples/memgrp.cfg index d609778..8f5d9e4 100644 --- a/examples/memgrp.cfg +++ b/examples/memgrp.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/mux.cfg b/examples/mux.cfg index 861f2f6..a98e450 100644 --- a/examples/mux.cfg +++ b/examples/mux.cfg @@ -16,3 +16,4 @@ ENABLE_PREPROCESSING = NO EXTRACT_PACKAGE = YES COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/overload.cfg b/examples/overload.cfg index 71ebcc5..ccb8d5b 100644 --- a/examples/overload.cfg +++ b/examples/overload.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/page.cfg b/examples/page.cfg index 972368a..8212978 100644 --- a/examples/page.cfg +++ b/examples/page.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/par.cfg b/examples/par.cfg index fe4be84..278e1b7 100644 --- a/examples/par.cfg +++ b/examples/par.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/pyexample.cfg b/examples/pyexample.cfg index 4569425..0a564ad 100644 --- a/examples/pyexample.cfg +++ b/examples/pyexample.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/qtstyle.cfg b/examples/qtstyle.cfg index 1516c7e..b55f4d8 100644 --- a/examples/qtstyle.cfg +++ b/examples/qtstyle.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/relates.cfg b/examples/relates.cfg index 89f46da..aa3f369 100644 --- a/examples/relates.cfg +++ b/examples/relates.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/restypedef.cfg b/examples/restypedef.cfg index 63d2ea5..b457da8 100644 --- a/examples/restypedef.cfg +++ b/examples/restypedef.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/structcmd.cfg b/examples/structcmd.cfg index f926ddf..0e8e98d 100644 --- a/examples/structcmd.cfg +++ b/examples/structcmd.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/tag.cfg b/examples/tag.cfg index 12b3c5b..3deacba 100644 --- a/examples/tag.cfg +++ b/examples/tag.cfg @@ -11,3 +11,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES diff --git a/examples/templ.cfg b/examples/templ.cfg index c34633f..adfe8ec 100644 --- a/examples/templ.cfg +++ b/examples/templ.cfg @@ -10,3 +10,4 @@ JAVADOC_AUTOBRIEF = YES SEARCHENGINE = NO COMPACT_LATEX = YES LATEX_HIDE_INDICES = YES +WARN_AS_ERROR = YES -- cgit v0.12