[Doxygen] Layout adjustments (#6196)

* Layout adjustments. Took 1 hour 54 minutes Took 2 minutes Took 6 minutes * Remove the empty building page. Took 7 minutes * Change to @page Took 11 minutes * Change to @page again Took 52 seconds * Change to @page again again Took 2 minutes * Fence the page declaration in CONTRIBUTING.md Took 8 minutes --------- Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
2025-12-12 07:40:30 -08:00 · 2025-09-30 11:45:49 +02:00
parent e318815025
commit 22c6756ce0
9 changed files with 302 additions and 7 deletions
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,3 +1,5 @@
+<!--! @page contributing Contributing -->
+
 &nbsp; [Introduction](#contributing-to-cockatrice) | [Code Style Guide](
 #code-style-guide) | [Translations](#translations) | [Release Management](
 #release-management)
--- a/12
+++ b/12
@@ -48,7 +48,7 @@ PROJECT_NAME           = "Cockatrice"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.

-PROJECT_NUMBER         =
+PROJECT_NUMBER         = 2.11

 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewers a
@@ -61,13 +61,13 @@ PROJECT_BRIEF          =
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.

-PROJECT_LOGO           =
+PROJECT_LOGO           = cockatrice/resources/cockatrice.png

 # With the PROJECT_ICON tag one can specify an icon that is included in the tabs
 # when the HTML document is shown. Doxygen will copy the logo to the output
 # directory.

-PROJECT_ICON           =
+PROJECT_ICON           = cockatrice/resources/cockatrice.png

 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -839,7 +839,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.

-LAYOUT_FILE            =
+LAYOUT_FILE            = DoxygenLayout.xml

 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -991,7 +991,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.

-INPUT                  = cockatrice common
+INPUT                  = .github/CONTRIBUTING.md cockatrice common doc/doxygen-extra-pages

 # This tag can be used to specify the character encoding of the source files
 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1749,7 +1749,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.

-DISABLE_INDEX          = NO
+DISABLE_INDEX          = YES

 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information. If the tag
--- a/DoxygenLayout.xml
+++ b/DoxygenLayout.xml
@@ -0,0 +1,271 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<doxygenlayout version="2.0">
+    <!-- Generated by doxygen 1.14.0 -->
+    <!-- Navigation index tabs for HTML output -->
+    <navindex>
+        <tab type="mainpage" visible="yes" title=""/>
+        <tab type="pages" visible="yes" title="" intro=""/>
+        <tab type="topics" visible="yes" title="" intro=""/>
+        <tab type="usergroup" title="Code Reference">
+            <tab type="modules" visible="yes" title="" intro="">
+                <tab type="modulelist" visible="yes" title="" intro=""/>
+                <tab type="modulemembers" visible="yes" title="" intro=""/>
+            </tab>
+            <tab type="namespaces" visible="yes" title="">
+                <tab type="namespacelist" visible="yes" title="" intro=""/>
+                <tab type="namespacemembers" visible="yes" title="" intro=""/>
+            </tab>
+            <tab type="concepts" visible="yes" title="">
+            </tab>
+            <tab type="interfaces" visible="yes" title="">
+                <tab type="interfacelist" visible="yes" title="" intro=""/>
+                <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
+                <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+            </tab>
+            <tab type="classes" visible="yes" title="">
+                <tab type="classlist" visible="yes" title="" intro=""/>
+                <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+                <tab type="hierarchy" visible="yes" title="" intro=""/>
+                <tab type="classmembers" visible="yes" title="" intro=""/>
+            </tab>
+            <tab type="structs" visible="yes" title="">
+                <tab type="structlist" visible="yes" title="" intro=""/>
+                <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
+            </tab>
+            <tab type="exceptions" visible="yes" title="">
+                <tab type="exceptionlist" visible="yes" title="" intro=""/>
+                <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
+                <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
+            </tab>
+            <tab type="files" visible="yes" title="">
+                <tab type="filelist" visible="yes" title="" intro=""/>
+                <tab type="globals" visible="yes" title="" intro=""/>
+            </tab>
+            <tab type="examples" visible="yes" title="" intro=""/>
+        </tab>
+    </navindex>
+
+    <!-- Layout definition for a class page -->
+    <class>
+        <briefdescription visible="yes"/>
+        <includes visible="$SHOW_HEADERFILE"/>
+        <inheritancegraph visible="yes"/>
+        <collaborationgraph visible="yes"/>
+        <memberdecl>
+            <nestedclasses visible="yes" title=""/>
+            <publictypes visible="yes" title=""/>
+            <services visible="yes" title=""/>
+            <interfaces visible="yes" title=""/>
+            <publicslots visible="yes" title=""/>
+            <signals visible="yes" title=""/>
+            <publicmethods visible="yes" title=""/>
+            <publicstaticmethods visible="yes" title=""/>
+            <publicattributes visible="yes" title=""/>
+            <publicstaticattributes visible="yes" title=""/>
+            <protectedtypes visible="yes" title=""/>
+            <protectedslots visible="yes" title=""/>
+            <protectedmethods visible="yes" title=""/>
+            <protectedstaticmethods visible="yes" title=""/>
+            <protectedattributes visible="yes" title=""/>
+            <protectedstaticattributes visible="yes" title=""/>
+            <packagetypes visible="yes" title=""/>
+            <packagemethods visible="yes" title=""/>
+            <packagestaticmethods visible="yes" title=""/>
+            <packageattributes visible="yes" title=""/>
+            <packagestaticattributes visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+            <events visible="yes" title=""/>
+            <privatetypes visible="yes" title=""/>
+            <privateslots visible="yes" title=""/>
+            <privatemethods visible="yes" title=""/>
+            <privatestaticmethods visible="yes" title=""/>
+            <privateattributes visible="yes" title=""/>
+            <privatestaticattributes visible="yes" title=""/>
+            <friends visible="yes" title=""/>
+            <related visible="yes" title="" subtitle=""/>
+            <membergroups visible="yes"/>
+        </memberdecl>
+        <detaileddescription visible="yes" title=""/>
+        <memberdef>
+            <inlineclasses visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <services visible="yes" title=""/>
+            <interfaces visible="yes" title=""/>
+            <constructors visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <related visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+            <events visible="yes" title=""/>
+        </memberdef>
+        <allmemberslink visible="yes"/>
+        <usedfiles visible="$SHOW_USED_FILES"/>
+        <authorsection visible="yes"/>
+    </class>
+
+    <!-- Layout definition for a namespace page -->
+    <namespace>
+        <briefdescription visible="yes"/>
+        <memberdecl>
+            <nestednamespaces visible="yes" title=""/>
+            <constantgroups visible="yes" title=""/>
+            <interfaces visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <concepts visible="yes" title=""/>
+            <structs visible="yes" title=""/>
+            <exceptions visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <sequences visible="yes" title=""/>
+            <dictionaries visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+            <membergroups visible="yes"/>
+        </memberdecl>
+        <detaileddescription visible="yes" title=""/>
+        <memberdef>
+            <inlineclasses visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <sequences visible="yes" title=""/>
+            <dictionaries visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+        </memberdef>
+        <authorsection visible="yes"/>
+    </namespace>
+
+    <!-- Layout definition for a concept page -->
+    <concept>
+        <briefdescription visible="yes"/>
+        <includes visible="$SHOW_HEADERFILE"/>
+        <definition visible="yes" title=""/>
+        <detaileddescription visible="yes" title=""/>
+        <authorsection visible="yes"/>
+    </concept>
+
+    <!-- Layout definition for a file page -->
+    <file>
+        <briefdescription visible="yes"/>
+        <includes visible="$SHOW_INCLUDE_FILES"/>
+        <includegraph visible="yes"/>
+        <includedbygraph visible="yes"/>
+        <sourcelink visible="yes"/>
+        <memberdecl>
+            <interfaces visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <structs visible="yes" title=""/>
+            <exceptions visible="yes" title=""/>
+            <namespaces visible="yes" title=""/>
+            <concepts visible="yes" title=""/>
+            <constantgroups visible="yes" title=""/>
+            <defines visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <sequences visible="yes" title=""/>
+            <dictionaries visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+            <membergroups visible="yes"/>
+        </memberdecl>
+        <detaileddescription visible="yes" title=""/>
+        <memberdef>
+            <inlineclasses visible="yes" title=""/>
+            <defines visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <sequences visible="yes" title=""/>
+            <dictionaries visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+        </memberdef>
+        <authorsection/>
+    </file>
+
+    <!-- Layout definition for a group page -->
+    <group>
+        <briefdescription visible="yes"/>
+        <groupgraph visible="yes"/>
+        <memberdecl>
+            <nestedgroups visible="yes" title=""/>
+            <modules visible="yes" title=""/>
+            <dirs visible="yes" title=""/>
+            <files visible="yes" title=""/>
+            <namespaces visible="yes" title=""/>
+            <concepts visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <defines visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <sequences visible="yes" title=""/>
+            <dictionaries visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <enumvalues visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <signals visible="yes" title=""/>
+            <publicslots visible="yes" title=""/>
+            <protectedslots visible="yes" title=""/>
+            <privateslots visible="yes" title=""/>
+            <events visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+            <friends visible="yes" title=""/>
+            <membergroups visible="yes"/>
+        </memberdecl>
+        <detaileddescription visible="yes" title=""/>
+        <memberdef>
+            <pagedocs/>
+            <inlineclasses visible="yes" title=""/>
+            <defines visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <sequences visible="yes" title=""/>
+            <dictionaries visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <enumvalues visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <signals visible="yes" title=""/>
+            <publicslots visible="yes" title=""/>
+            <protectedslots visible="yes" title=""/>
+            <privateslots visible="yes" title=""/>
+            <events visible="yes" title=""/>
+            <properties visible="yes" title=""/>
+            <friends visible="yes" title=""/>
+        </memberdef>
+        <authorsection visible="yes"/>
+    </group>
+
+    <!-- Layout definition for a C++20 module page -->
+    <module>
+        <briefdescription visible="yes"/>
+        <exportedmodules visible="yes"/>
+        <memberdecl>
+            <concepts visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <enums visible="yes" title=""/>
+            <typedefs visible="yes" title=""/>
+            <functions visible="yes" title=""/>
+            <variables visible="yes" title=""/>
+            <membergroups visible="yes" title=""/>
+        </memberdecl>
+        <detaileddescription visible="yes" title=""/>
+        <memberdecl>
+            <files visible="yes"/>
+        </memberdecl>
+    </module>
+
+    <!-- Layout definition for a directory page -->
+    <directory>
+        <briefdescription visible="yes"/>
+        <directorygraph visible="yes"/>
+        <memberdecl>
+            <dirs visible="yes"/>
+            <files visible="yes"/>
+        </memberdecl>
+        <detaileddescription visible="yes" title=""/>
+    </directory>
+</doxygenlayout>
--- a/cockatrice/resources/help/deck_search.md
+++ b/cockatrice/resources/help/deck_search.md
@@ -1,3 +1,5 @@
+@page deck_search_syntax_help Deck Search Syntax Help
+
 ## Deck Search Syntax Help
 -----
 The search bar recognizes a set of special commands.<br>
--- a/cockatrice/resources/help/search.md
+++ b/cockatrice/resources/help/search.md
@@ -1,3 +1,5 @@
+@page search_syntax_help Search Syntax Help
+
 ## Search Syntax Help
 -----
 The search bar recognizes a set of special commands similar to some other card databases.<br>
--- a/cockatrice/src/filters/syntax_help.cpp
+++ b/cockatrice/src/filters/syntax_help.cpp
@@ -22,8 +22,11 @@ static QTextBrowser *createBrowser(const QString &helpFile)
    QString text = in.readAll();
    file.close();

-    // Poor Markdown Converter
+    // --- Remove @page declarations at the top of the file ---
    auto opts = QRegularExpression::MultilineOption;
+    text = text.replace(QRegularExpression(R"(^\s*@page[^\n]*\n)", opts), "");
+
+    // Poor Markdown Converter
    text = text.replace(QRegularExpression("^(###)(.*)", opts), "<h3>\\2</h3>")
               .replace(QRegularExpression("^(##)(.*)", opts), "<h2>\\2</h2>")
               .replace(QRegularExpression("^(#)(.*)", opts), "<h1>\\2</h1>")
--- a/doc/doxygen-extra-pages/developer_documentation/index.md
+++ b/doc/doxygen-extra-pages/developer_documentation/index.md
@@ -0,0 +1,3 @@
+@page developer_reference Developer Reference
+
+- [Contributing](@subpage contributing)
--- a/doc/doxygen-extra-pages/index.md
+++ b/doc/doxygen-extra-pages/index.md
@@ -0,0 +1,8 @@
+@mainpage Cockatrice Documentation
+
+# Welcome
+
+This is the **main landing page** of the Cockatrice documentation.
+
+- Go to the @subpage user_reference page
+- Or check out the @subpage developer_reference
--- a/doc/doxygen-extra-pages/user_documentation/index.md
+++ b/doc/doxygen-extra-pages/user_documentation/index.md
@@ -0,0 +1,4 @@
+@page user_reference User Reference
+
+@subpage search_syntax_help
+@subpage deck_search_syntax_help