From ba19a3259ba26adc710523d10470ee220476c85a Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Tue, 11 Jun 2024 20:29:04 +0100 Subject: [PATCH] Update Doxygen config and fix some warnings. --- docs/Doxyfile | 8 ++++++++ include/modules/extban.h | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 2a29708c4..b9aef2828 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -3,6 +3,7 @@ PROJECT_NAME = InspIRCd PROJECT_NUMBER = v4 PROJECT_BRIEF = PROJECT_LOGO = +PROJECT_ICON = win/inspircd.ico OUTPUT_DIRECTORY = docs/doxygen CREATE_SUBDIRS = NO CREATE_SUBDIRS_LEVEL = 8 @@ -147,6 +148,9 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 HTML_DYNAMIC_MENUS = YES HTML_DYNAMIC_SECTIONS = NO +HTML_CODE_FOLDING = YES +HTML_COPY_CLIPBOARD = YES +HTML_PROJECT_COOKIE = HTML_INDEX_NUM_ENTRIES = 100 GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated documentation" @@ -219,6 +223,7 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = +RTF_EXTRA_FILES = GENERATE_MAN = NO MAN_OUTPUT = man MAN_EXTENSION = .3 @@ -231,6 +236,9 @@ XML_NS_MEMB_FILE_SCOPE = NO GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook GENERATE_AUTOGEN_DEF = NO +GENERATE_SQLITE3 = NO +SQLITE3_OUTPUT = sqlite3 +SQLITE3_RECREATE_DB = YES GENERATE_PERLMOD = NO PERLMOD_LATEX = NO PERLMOD_PRETTY = YES diff --git a/include/modules/extban.h b/include/modules/extban.h index 2a3ae4954..0382fb3c5 100644 --- a/include/modules/extban.h +++ b/include/modules/extban.h @@ -114,9 +114,10 @@ public: virtual bool Canonicalize(std::string& text) const = 0; /** Compares an entry from this list with the specified value. + * @param lm The list mode which is the entry exists on. * @param entry The list entry to compare against. * @param value The value to compare to. - * @return ... + * @return MATCH if the entries match and NOT_MATCH if the entries do not match. */ virtual Comparison CompareEntry(const ListModeBase* lm, const std::string& entry, const std::string& value) const = 0;