fix(docs): Doxygen warnings

Author: benthevining

docs/CMakeLists.txt

@@ -32,24 +32,6 @@ set (DOXYGEN_STRIP_FROM_INC_PATH
      "${BenBot_SOURCE_DIR}/ben-bot/include" "${BenBot_SOURCE_DIR}/ben-bot/resources/include"
 )
 
-# generate the engine docs page
-
-set (engine_doc_page "${CMAKE_CURRENT_BINARY_DIR}/engine_docs.txt")
-
-# all files must exist at configure time when using doxygen_add_docs()'s stamp file option
-file (TOUCH "${engine_doc_page}")
-
-set (generator_script "${CMAKE_CURRENT_LIST_DIR}/GenerateEngineDocs.cmake")
-
-add_custom_command (
-    OUTPUT "${engine_doc_page}"
-    COMMAND "${CMAKE_COMMAND}" -D "OUTPUT_FILE=${engine_doc_page}" -D
-            "ENGINE_PATH=$<TARGET_FILE:ben_bot::ben_bot>" -P "${generator_script}"
-    DEPENDS ben_bot::ben_bot "${generator_script}" "${CMAKE_CURRENT_LIST_DIR}/engine-docs.txt"
-    COMMENT "Generating engine docs page..."
-    VERBATIM USES_TERMINAL
-)
-
 #
 
 get_target_property (libutil_headers ben_bot::libutil HEADER_SET)
@@ -64,7 +46,6 @@ doxygen_add_docs (
     "${CMAKE_CURRENT_LIST_DIR}/uci-spec.txt"
     "${CMAKE_CURRENT_LIST_DIR}/top-level-groups.txt"
     "${CMAKE_CURRENT_LIST_DIR}/CodeStyle.md"
-    "${engine_doc_page}"
     ${libutil_headers}
     ${libchess_headers}
     ${libbenbot_headers}

docs/GenerateEngineDocs.cmake

@@ -98,7 +98,7 @@ class [[nodiscard]] Engine final : public uci::EngineBase {
 
     void print_logo_and_version() const;
     void print_help(string_view args) const;
-    void print_options(string_view args) const;
+    void print_options() const;
     void print_current_position(string_view arguments) const;
 
     void set_pretty_printing(bool shouldPrettyPrint);
@@ -204,9 +204,9 @@ class [[nodiscard]] Engine final : public uci::EngineBase {
         },
         CustomCommand {
             .name = "options",
-            .action = [this](const string_view args){ print_options(args); },
+            .action = [this](const string_view args){ print_options(); },
             .description = "Dump current UCI option values",
-            .argsHelp = "[--no-current]"
+            .argsHelp = {}
         },
         CustomCommand {
             .name = "perft",

docs/engine-docs.txt

@@ -79,15 +79,8 @@ void Engine::print_help(const string_view args) const
     print_colored_table(table);
 }
 
-void Engine::print_options(const string_view args) const
+void Engine::print_options() const
 {
-    const bool noCurrent = [args] {
-        if (args.empty())
-            return false;
-
-        return trim(args) == "--no-current";
-    }();
-
     println("");
     println("The following UCI options are supported:");
     println("");
@@ -97,10 +90,8 @@ void Engine::print_options(const string_view args) const
     table.append_column("Option")
         .append_column("Type")
         .append_column("Notes")
-        .append_column("Default");
-
-    if (not noCurrent)
-        table.append_column("Current");
+        .append_column("Default")
+        .append_column("Current");
 
     for (const auto* option : options) {
         table.new_row()
@@ -115,22 +106,18 @@ void Engine::print_options(const string_view args) const
                 },
                 option->get_default_value_variant());
 
-            if (not noCurrent) {
-                std::visit(
-                    [&table](auto value) {
-                        table.append_column(std::format("{}", value));
-                    },
-                    option->get_value_variant());
-            }
+            std::visit(
+                [&table](auto value) {
+                    table.append_column(std::format("{}", value));
+                },
+                option->get_value_variant());
         }
     }
 
     print_colored_table(table);
 
     println("");
-
-    if (not noCurrent)
-        println("Debug mode: {}", debugMode.load());
+    println("Debug mode: {}", debugMode.load());
 }
 
 void Engine::print_current_position(const string_view arguments) const