From dba9bf2a5d7261ea3ba537d76b8f6cb43c7d1d5c Mon Sep 17 00:00:00 2001 From: Pentarctagon Date: Wed, 16 Feb 2022 09:09:51 -0600 Subject: [PATCH] Workaround doxygen issue. The root cause seems to be a parsing issue in Doxygen, described in #6528. So given this isn't our own code and we want to keep the numbner of patches that need to be applied to a minimum, tell Doxygen to ignore the lua source directory entirely. This does then (somehow) reveal another issue in another unrelated source file where it's referencing a method in its documentation that doesn't actually exist. Fixes #6528 --- Doxyfile | 3 ++- src/whiteboard/action.hpp | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Doxyfile b/Doxyfile index 2ddcb810747..b1a19730d2f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -905,7 +905,8 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = */src/modules/* +EXCLUDE_PATTERNS = */src/modules/* \ + */src/lua/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/src/whiteboard/action.hpp b/src/whiteboard/action.hpp index e175a196a94..4c1cc14f717 100644 --- a/src/whiteboard/action.hpp +++ b/src/whiteboard/action.hpp @@ -101,7 +101,7 @@ public: /** * Possible errors. * - * Returned by the @ref check function. + * Returned by the @ref check_validity function. */ enum error {