mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-11-05 01:23:24 -08:00
[CI] Use Doxygen v1.18.0 (#7374)
Some checks are pending
CodeQL / Analyze (cpp) (push) Waiting to run
CodeQL / Analyze (actions) (push) Waiting to run
Build Docker / Servatrice (arm) (push) Waiting to run
Build Docker / Servatrice (x86) (push) Waiting to run
Build Docker / Publish multi-platform Servatrice image (push) Blocked by required conditions
Some checks are pending
CodeQL / Analyze (cpp) (push) Waiting to run
CodeQL / Analyze (actions) (push) Waiting to run
Build Docker / Servatrice (arm) (push) Waiting to run
Build Docker / Servatrice (x86) (push) Waiting to run
Build Docker / Publish multi-platform Servatrice image (push) Blocked by required conditions
* Bump doxygen version to v1.18.0 * Update Doxyfile config to v1.18.0 * bump batch size * bump more
This commit is contained in:
parent
6816c580cf
commit
61e01990c4
2 changed files with 77 additions and 22 deletions
2
.github/workflows/documentation-build.yml
vendored
2
.github/workflows/documentation-build.yml
vendored
|
|
@ -41,7 +41,7 @@ jobs:
|
|||
- name: "Install Doxygen"
|
||||
uses: ssciwr/doxygen-install@v2
|
||||
with:
|
||||
version: "1.16.1"
|
||||
version: "1.18.0"
|
||||
|
||||
- name: "Update Doxygen Configuration"
|
||||
run: |
|
||||
|
|
|
|||
97
Doxyfile
97
Doxyfile
|
|
@ -1,4 +1,4 @@
|
|||
# Doxyfile 1.16.1
|
||||
# Doxyfile 1.18.0
|
||||
|
||||
# This file describes the settings to be used by the documentation system
|
||||
# Doxygen (www.doxygen.org) for a project.
|
||||
|
|
@ -11,7 +11,7 @@
|
|||
# TAG = value [value, ...]
|
||||
# For lists, items can also be appended using:
|
||||
# TAG += value [value, ...]
|
||||
# Values that contain spaces should be placed between quotes (\" \").
|
||||
# Values that contain spaces should be placed between quotes (" ").
|
||||
#
|
||||
# Note:
|
||||
#
|
||||
|
|
@ -81,7 +81,7 @@ OUTPUT_DIRECTORY = docs
|
|||
# and will distribute the generated files over these directories. Enabling this
|
||||
# option can be useful when feeding Doxygen a huge amount of source files, where
|
||||
# putting all generated files in the same directory would otherwise cause
|
||||
# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
|
||||
# performance problems for the file system. Adjust CREATE_SUBDIRS_LEVEL to
|
||||
# control the number of sub-directories.
|
||||
# The default value is: NO.
|
||||
|
||||
|
|
@ -802,7 +802,7 @@ GENERATE_REQUIREMENTS = YES
|
|||
|
||||
# The REQ_TRACEABILITY_INFO tag controls if traceability information is shown on
|
||||
# the requirements page (only relevant when using \requirement comment blocks).
|
||||
# The setting NO will disable the traceablility information altogether. The
|
||||
# The setting NO will disable the traceability information altogether. The
|
||||
# setting UNSATISFIED_ONLY will show a list of requirements that are missing a
|
||||
# satisfies relation (through the command: \satisfies). Similarly the setting
|
||||
# UNVERIFIED_ONLY will show a list of requirements that are missing a verifies
|
||||
|
|
@ -855,8 +855,8 @@ SHOW_NAMESPACES = YES
|
|||
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
||||
# Doxygen should invoke to get the current version for each file (typically from
|
||||
# the version control system). Doxygen will invoke the program by executing (via
|
||||
# popen()) the command command input-file, where command is the value of the
|
||||
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
|
||||
# popen()) the command command input_file, where command is the value of the
|
||||
# FILE_VERSION_FILTER tag, and input_file is the name of an input file provided
|
||||
# by Doxygen. Whatever the program writes to standard output is used as the file
|
||||
# version. For an example see the documentation.
|
||||
|
||||
|
|
@ -1643,8 +1643,8 @@ DOCSET_PUBLISHER_NAME = Publisher
|
|||
# a.o. the download links, offline (the HTML help workshop was already many
|
||||
# years in maintenance mode). You can download the HTML help workshop from the
|
||||
# web archives at Installation executable (see:
|
||||
# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
|
||||
# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
|
||||
# http://web.archive.org/web/20160201063255/https://download.microsoft.com/downl
|
||||
# oad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
|
||||
#
|
||||
# The HTML Help Workshop contains a compiler that can convert all HTML output
|
||||
# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML
|
||||
|
|
@ -1951,7 +1951,7 @@ MATHJAX_FORMAT = HTML-CSS
|
|||
# output directory using the MATHJAX_RELPATH option. For Mathjax version 2 the
|
||||
# destination directory should contain the MathJax.js script. For instance, if
|
||||
# the mathjax directory is located at the same level as the HTML output
|
||||
# directory, then MATHJAX_RELPATH should be ../mathjax.s For Mathjax versions 3
|
||||
# directory, then MATHJAX_RELPATH should be ../mathjax. For Mathjax versions 3
|
||||
# and 4 the destination directory should contain the tex-<format>.js script
|
||||
# (where <format> is either chtml or svg). The default value points to the
|
||||
# MathJax Content Delivery Network so you can quickly see the result without
|
||||
|
|
@ -2172,9 +2172,8 @@ EXTRA_PACKAGES =
|
|||
#
|
||||
# Note: Only use a user-defined header if you know what you are doing!
|
||||
# Note: The header is subject to change so you typically have to regenerate the
|
||||
# default header when upgrading to a newer version of Doxygen. The following
|
||||
# commands have a special meaning inside the header (and footer): For a
|
||||
# description of the possible markers and block names see the documentation.
|
||||
# default header when upgrading to a newer version of Doxygen. For a description
|
||||
# of the possible markers and block names see the documentation.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_HEADER =
|
||||
|
|
@ -2657,6 +2656,19 @@ HAVE_DOT = YES
|
|||
|
||||
DOT_NUM_THREADS = 0
|
||||
|
||||
# The DOT_BATCH_SIZE specifies the number of dot graphs Doxygen is allowed to
|
||||
# compile in a single invocation of dot. When set to 1 Doxygen will invoke dot
|
||||
# for each graph separately, which can cause significant process creation
|
||||
# overhead especially on systems with many CPU cores. Together with
|
||||
# DOT_NUM_THREADS this setting can be used to optimise the dot processing speed
|
||||
# for a particular system. Doxygen will try to give each thread a balanced batch
|
||||
# of work. If the total number of graphs to process exceeds DOT_NUM_THREADS *
|
||||
# DOT_BATCH_SIZE then additional batches will be created for dot to process.
|
||||
# Minimum value: 1, maximum value: 1000, default value: 50.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_BATCH_SIZE = 500
|
||||
|
||||
# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
|
||||
# subgraphs. When you want a differently looking font in the dot files that
|
||||
# Doxygen generates you can specify fontname, fontcolor and fontsize attributes.
|
||||
|
|
@ -2948,6 +2960,58 @@ PLANTUML_INCLUDE_PATH =
|
|||
|
||||
PLANTUMLFILE_DIRS =
|
||||
|
||||
# When using Mermaid diagrams with CLI rendering, the MERMAID_PATH tag should be
|
||||
# used to specify the directory where the mmdc (Mermaid CLI) executable can be
|
||||
# found. If left blank, CLI-based rendering is disabled. For HTML output,
|
||||
# client-side rendering via JavaScript is used by default and does not require
|
||||
# mmdc. For LaTeX/PDF output, mmdc is required to pre-generate images. Doxygen
|
||||
# will generate a warning when CLI rendering is needed but mmdc is not
|
||||
# available.
|
||||
|
||||
MERMAID_PATH =
|
||||
|
||||
# When using Mermaid diagrams, the MERMAID_CONFIG_FILE tag can be used to
|
||||
# specify a JSON configuration file for the Mermaid CLI tool (mmdc). This file
|
||||
# can contain theme settings and other Mermaid configuration options.
|
||||
|
||||
MERMAID_CONFIG_FILE =
|
||||
|
||||
# The MERMAID_RENDER_MODE tag selects how Mermaid diagrams are rendered.
|
||||
# Possible values are: AUTO (use client-side rendering for HTML and mmdc for
|
||||
# LaTeX/PDF and other formats. If MERMAID_PATH is not set, non-HTML diagrams
|
||||
# will produce a warning), CLI (use the mmdc tool to pre-generate images
|
||||
# (requires Node.js and mermaid-js/mermaid-cli). Works for all output formats)
|
||||
# and CLIENT_SIDE (embed mermaid.js in HTML output for client-side rendering.
|
||||
# Does not require mmdc but only works for HTML output).
|
||||
# The default value is: AUTO.
|
||||
|
||||
MERMAID_RENDER_MODE = AUTO
|
||||
|
||||
# The MERMAID_JS_URL tag specifies the URL to load mermaid.js from when using
|
||||
# client-side rendering (MERMAID_RENDER_MODE is CLIENT_SIDE or AUTO). The
|
||||
# default points to the latest Mermaid v11 release on the jsDelivr CDN.
|
||||
#
|
||||
# The default CDN URL requires internet access when viewing the generated
|
||||
# documentation. For offline use, download mermaid.esm.min.mjs and set this to a
|
||||
# relative path, or use MERMAID_RENDER_MODE=CLI to pre-generate images instead.
|
||||
# Examples:
|
||||
# - Latest v11 (default):
|
||||
# https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs
|
||||
# - Pinned version:
|
||||
# https://cdn.jsdelivr.net/npm/mermaid@11.3.0/dist/mermaid.esm.min.mjs
|
||||
# - Local copy: ./mermaid.esm.min.mjs (user must place file in HTML output
|
||||
# directory)
|
||||
# The default value is:
|
||||
# https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs.
|
||||
|
||||
MERMAID_JS_URL = https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs
|
||||
|
||||
# The MERMAIDFILE_DIRS tag can be used to specify one or more directories that
|
||||
# contain Mermaid files that are included in the documentation (see the
|
||||
# \mermaidfile command).
|
||||
|
||||
MERMAIDFILE_DIRS =
|
||||
|
||||
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
|
||||
# that will be shown in the graph. If the number of nodes in a graph becomes
|
||||
# larger than this value, Doxygen will truncate the graph, which is visualized
|
||||
|
|
@ -2972,15 +3036,6 @@ DOT_GRAPH_MAX_NODES = 50
|
|||
|
||||
MAX_DOT_GRAPH_DEPTH = 0
|
||||
|
||||
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
|
||||
# files in one run (i.e. multiple -o and -T options on the command line). This
|
||||
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
|
||||
# this, this feature is disabled by default.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_MULTI_TARGETS = NO
|
||||
|
||||
# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
|
||||
# explaining the meaning of the various boxes and arrows in the dot generated
|
||||
# graphs.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue