mirror of
https://github.com/wxWidgets/wxWidgets.git
synced 2026-08-17 00:47:34 +08:00
Upgrade to Doxygen 1.15.0
- Upgrade Doxyfile configuration for 1.15.0 - Upgrade Doxygen Awesome to v2.4.2 (compatible up to Doxygen 1.15.0) - Upgrade GitHub workflow Doxygen version to 1.15.0 - Tweak main navigation button spacing to match previous style - Fix search box icon styles - Fix class member definition group styles (missed by DA) - Replace backticks used as apostrophe/quote in docs - Fix remaining Doxygen warnings when processed with 1.15.0 - Bump required Doxygen version to 1.15.0 Closes #25603. Closes #26431.
This commit is contained in:
Bryan Petty
committed by
Vadim Zeitlin
Vadim Zeitlin
parent
488e7363bc
commit
9864777203
@@ -23,7 +23,7 @@ permissions:
|
||||
|
||||
jobs:
|
||||
update:
|
||||
runs-on: ubuntu-22.04
|
||||
runs-on: ubuntu-24.04
|
||||
name: Update Online Documentation
|
||||
|
||||
steps:
|
||||
@@ -31,8 +31,16 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install doxygen
|
||||
env:
|
||||
DOXYGEN_VERSION: '1.15.0'
|
||||
run: |
|
||||
sudo apt-get -q -o=Dpkg::Use-Pty=0 -y install doxygen graphviz
|
||||
wget --progress=dot:mega https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
|
||||
tar xzvf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
|
||||
cd doxygen-${DOXYGEN_VERSION}
|
||||
sudo make install
|
||||
cd ..
|
||||
rm -rf doxygen-${DOXYGEN_VERSION}* # Clean up
|
||||
sudo apt-get -q -o=Dpkg::Use-Pty=0 -y install graphviz
|
||||
|
||||
- name: Customize for online docs
|
||||
working-directory: docs/doxygen
|
||||
|
||||
@@ -179,6 +179,7 @@
|
||||
/distrib/release
|
||||
|
||||
# /docs/doxygen/
|
||||
/docs/doxygen/doxygen.log
|
||||
/docs/doxygen/out
|
||||
|
||||
# /include/
|
||||
|
||||
+74
-14
@@ -1,4 +1,4 @@
|
||||
# Doxyfile 1.8.8
|
||||
# Doxyfile 1.15.0
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Project Options
|
||||
@@ -9,8 +9,10 @@ PROJECT_NAME = wxWidgets
|
||||
PROJECT_NUMBER = 3.3.3
|
||||
PROJECT_BRIEF =
|
||||
PROJECT_LOGO = logo.png
|
||||
PROJECT_ICON =
|
||||
OUTPUT_DIRECTORY = out
|
||||
CREATE_SUBDIRS = NO
|
||||
CREATE_SUBDIRS_LEVEL = 8
|
||||
ALLOW_UNICODE_NAMES = NO
|
||||
OUTPUT_LANGUAGE = English
|
||||
BRIEF_MEMBER_DESC = YES
|
||||
@@ -24,8 +26,10 @@ STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
|
||||
"$(WXWIDGETS)/interface/"
|
||||
SHORT_NAMES = NO
|
||||
JAVADOC_AUTOBRIEF = YES # Default: NO
|
||||
JAVADOC_BANNER = NO
|
||||
QT_AUTOBRIEF = NO
|
||||
MULTILINE_CPP_IS_BRIEF = NO
|
||||
PYTHON_DOCSTRING = YES
|
||||
INHERIT_DOCS = YES
|
||||
SEPARATE_MEMBER_PAGES = NO
|
||||
TAB_SIZE = 4
|
||||
@@ -33,19 +37,27 @@ OPTIMIZE_OUTPUT_FOR_C = NO
|
||||
OPTIMIZE_OUTPUT_JAVA = NO
|
||||
OPTIMIZE_FOR_FORTRAN = NO
|
||||
OPTIMIZE_OUTPUT_VHDL = NO
|
||||
OPTIMIZE_OUTPUT_SLICE = NO
|
||||
EXTENSION_MAPPING =
|
||||
MARKDOWN_SUPPORT = YES
|
||||
MARKDOWN_STRICT = YES
|
||||
TOC_INCLUDE_HEADINGS = 3
|
||||
MARKDOWN_ID_STYLE = DOXYGEN
|
||||
AUTOLINK_SUPPORT = YES
|
||||
AUTOLINK_IGNORE_WORDS =
|
||||
BUILTIN_STL_SUPPORT = NO
|
||||
CPP_CLI_SUPPORT = NO
|
||||
SIP_SUPPORT = NO
|
||||
IDL_PROPERTY_SUPPORT = NO # Default: YES
|
||||
DISTRIBUTE_GROUP_DOC = YES # Default: NO
|
||||
GROUP_NESTED_COMPOUNDS = NO
|
||||
SUBGROUPING = YES
|
||||
INLINE_GROUPED_CLASSES = NO # TODO: Examine this setting.
|
||||
INLINE_SIMPLE_STRUCTS = NO # TODO: Examine this setting.
|
||||
TYPEDEF_HIDES_STRUCT = NO
|
||||
LOOKUP_CACHE_SIZE = 0
|
||||
NUM_PROC_THREADS = 1
|
||||
TIMESTAMP = YES # Default: NO
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -244,25 +256,30 @@ ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets
|
||||
|
||||
EXTRACT_ALL = YES # Default: NO
|
||||
EXTRACT_PRIVATE = YES # Default: NO
|
||||
EXTRACT_PRIV_VIRTUAL = NO
|
||||
EXTRACT_PACKAGE = NO
|
||||
EXTRACT_STATIC = YES # Default: NO
|
||||
EXTRACT_LOCAL_CLASSES = YES
|
||||
EXTRACT_LOCAL_METHODS = NO
|
||||
EXTRACT_ANON_NSPACES = YES # TODO: Default: NO
|
||||
RESOLVE_UNNAMED_PARAMS = YES
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
HIDE_UNDOC_NAMESPACES = YES
|
||||
HIDE_FRIEND_COMPOUNDS = NO
|
||||
HIDE_IN_BODY_DOCS = NO
|
||||
INTERNAL_DOCS = NO
|
||||
CASE_SENSE_NAMES = NO # Default: YES
|
||||
HIDE_SCOPE_NAMES = NO
|
||||
HIDE_COMPOUND_REFERENCE= NO
|
||||
SHOW_HEADERFILE = YES
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
SHOW_GROUPED_MEMB_INC = NO # TODO: YES
|
||||
FORCE_LOCAL_INCLUDES = NO
|
||||
INLINE_INFO = YES
|
||||
SORT_MEMBER_DOCS = YES
|
||||
SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
|
||||
SORT_MEMBERS_CTORS_1ST = NO # Default: NO
|
||||
SORT_MEMBERS_CTORS_1ST = NO
|
||||
SORT_GROUP_NAMES = YES # Default: NO
|
||||
SORT_BY_SCOPE_NAME = NO
|
||||
STRICT_PROTO_MATCHING = NO
|
||||
@@ -279,6 +296,7 @@ SHOW_NAMESPACES = NO # TODO: Default: YES
|
||||
FILE_VERSION_FILTER =
|
||||
LAYOUT_FILE = DoxygenLayout.xml
|
||||
CITE_BIB_FILES =
|
||||
EXTERNAL_TOOL_PATH =
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -289,8 +307,13 @@ QUIET = YES # Default: NO
|
||||
WARNINGS = YES
|
||||
WARN_IF_UNDOCUMENTED = YES
|
||||
WARN_IF_DOC_ERROR = YES
|
||||
WARN_IF_INCOMPLETE_DOC = YES
|
||||
WARN_NO_PARAMDOC = YES # Default: NO
|
||||
WARN_IF_UNDOC_ENUM_VAL = NO
|
||||
WARN_LAYOUT_FILE = YES
|
||||
WARN_AS_ERROR = NO
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LINE_FORMAT = "at line $line of file $file"
|
||||
WARN_LOGFILE = doxygen.log
|
||||
|
||||
|
||||
@@ -309,6 +332,7 @@ INPUT = mainpages \
|
||||
../x11 \
|
||||
../../interface
|
||||
INPUT_ENCODING = UTF-8
|
||||
INPUT_FILE_ENCODING =
|
||||
FILE_PATTERNS = *.h *.md
|
||||
RECURSIVE = YES # Default: NO
|
||||
EXCLUDE =
|
||||
@@ -324,6 +348,8 @@ FILTER_PATTERNS =
|
||||
FILTER_SOURCE_FILES = NO
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
IMPLICIT_DIR_DOCS = YES
|
||||
FORTRAN_COMMENT_AFTER = 72
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -339,6 +365,10 @@ REFERENCES_LINK_SOURCE = YES
|
||||
SOURCE_TOOLTIPS = YES
|
||||
USE_HTAGS = NO
|
||||
VERBATIM_HEADERS = NO # Default: YES
|
||||
CLANG_ASSISTED_PARSING = NO
|
||||
CLANG_ADD_INC_PATHS = YES
|
||||
CLANG_OPTIONS =
|
||||
CLANG_DATABASE_PATH =
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -361,11 +391,15 @@ HTML_FOOTER = custom_footer.html
|
||||
HTML_STYLESHEET =
|
||||
HTML_EXTRA_STYLESHEET = $(CUSTOM_THEME_CSS) extra_stylesheet.css
|
||||
HTML_EXTRA_FILES = $(CUSTOM_THEME_JS1) $(CUSTOM_THEME_JS2) wxwidgets.js
|
||||
HTML_COLORSTYLE = LIGHT # Required LIGHT for Doxygen Awesome
|
||||
HTML_COLORSTYLE_HUE = 220 # Default: 220
|
||||
HTML_COLORSTYLE_SAT = 255 # Default: 100
|
||||
HTML_COLORSTYLE_GAMMA = 100 # Default: 80
|
||||
HTML_TIMESTAMP = YES
|
||||
HTML_DYNAMIC_MENUS = YES # TODO: Maybe NO
|
||||
HTML_DYNAMIC_SECTIONS = YES # Default: NO
|
||||
HTML_CODE_FOLDING = YES
|
||||
HTML_COPY_CLIPBOARD = YES
|
||||
HTML_PROJECT_COOKIE =
|
||||
HTML_INDEX_NUM_ENTRIES = 100
|
||||
|
||||
|
||||
@@ -375,7 +409,8 @@ HTML_INDEX_NUM_ENTRIES = 100
|
||||
|
||||
GENERATE_DOCSET = $(GENERATE_DOCSET)
|
||||
DOCSET_FEEDNAME = "wxWidgets 3.3"
|
||||
DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx31
|
||||
DOCSET_FEEDURL =
|
||||
DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx33
|
||||
DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
|
||||
DOCSET_PUBLISHER_NAME = wxWidgets
|
||||
|
||||
@@ -391,7 +426,7 @@ GENERATE_CHI = NO
|
||||
CHM_INDEX_ENCODING =
|
||||
BINARY_TOC = NO
|
||||
TOC_EXPAND = NO
|
||||
TOC_INCLUDE_HEADINGS = 3
|
||||
SITEMAP_URL =
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -422,12 +457,18 @@ ECLIPSE_DOC_ID = org.wxwidgets.doxygen
|
||||
|
||||
DISABLE_INDEX = NO
|
||||
GENERATE_TREEVIEW = NO
|
||||
PAGE_OUTLINE_PANEL = YES
|
||||
FULL_SIDEBAR = NO # Required NO for Doxygen Awesome
|
||||
ENUM_VALUES_PER_LINE = 1 # Default: 4
|
||||
SHOW_ENUM_VALUES = NO
|
||||
TREEVIEW_WIDTH = 250
|
||||
EXT_LINKS_IN_WINDOW = YES # Default: NO
|
||||
OBFUSCATE_EMAILS = YES
|
||||
HTML_FORMULA_FORMAT = png
|
||||
FORMULA_FONTSIZE = 10
|
||||
FORMULA_TRANSPARENT = YES
|
||||
FORMULA_MACROFILE =
|
||||
USE_MATHJAX = NO
|
||||
MATHJAX_VERSION = MathJax_2
|
||||
MATHJAX_FORMAT = HTML-CSS
|
||||
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
||||
MATHJAX_EXTENSIONS =
|
||||
@@ -449,18 +490,20 @@ GENERATE_LATEX = $(GENERATE_LATEX)
|
||||
LATEX_OUTPUT = latex
|
||||
LATEX_CMD_NAME = latex
|
||||
MAKEINDEX_CMD_NAME = makeindex
|
||||
LATEX_MAKEINDEX_CMD = makeindex
|
||||
COMPACT_LATEX = NO
|
||||
PAPER_TYPE = a4
|
||||
EXTRA_PACKAGES =
|
||||
LATEX_HEADER = latex_header.tex
|
||||
LATEX_FOOTER =
|
||||
LATEX_EXTRA_STYLESHEET =
|
||||
LATEX_EXTRA_FILES =
|
||||
PDF_HYPERLINKS = YES
|
||||
USE_PDFLATEX = YES
|
||||
LATEX_BATCHMODE = YES # Default: NO
|
||||
LATEX_HIDE_INDICES = NO
|
||||
LATEX_SOURCE_CODE = NO
|
||||
LATEX_BIB_STYLE = plain
|
||||
LATEX_EMOJI_DIRECTORY =
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -473,6 +516,7 @@ COMPACT_RTF = NO
|
||||
RTF_HYPERLINKS = NO
|
||||
RTF_STYLESHEET_FILE =
|
||||
RTF_EXTENSIONS_FILE =
|
||||
RTF_EXTRA_FILES =
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -493,6 +537,7 @@ MAN_LINKS = NO
|
||||
GENERATE_XML = $(GENERATE_XML)
|
||||
XML_OUTPUT = xml
|
||||
XML_PROGRAMLISTING = NO # Default: YES
|
||||
XML_NS_MEMB_FILE_SCOPE = NO
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -501,7 +546,6 @@ XML_PROGRAMLISTING = NO # Default: YES
|
||||
|
||||
GENERATE_DOCBOOK = NO
|
||||
DOCBOOK_OUTPUT = docbook
|
||||
DOCBOOK_PROGRAMLISTING = NO
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -511,6 +555,15 @@ DOCBOOK_PROGRAMLISTING = NO
|
||||
GENERATE_AUTOGEN_DEF = NO
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Sqlite3 Output Options
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
GENERATE_SQLITE3 = NO
|
||||
SQLITE3_OUTPUT = sqlite3
|
||||
SQLITE3_RECREATE_DB = YES
|
||||
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Perl Module Output Options
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -552,19 +605,21 @@ EXTERNAL_PAGES = YES
|
||||
# dot Tool Options
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
CLASS_DIAGRAMS = YES
|
||||
DIA_PATH =
|
||||
HIDE_UNDOC_RELATIONS = YES
|
||||
HAVE_DOT = YES # Default: NO
|
||||
DOT_NUM_THREADS = 0
|
||||
DOT_FONTNAME =
|
||||
DOT_FONTSIZE = 10
|
||||
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
|
||||
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
|
||||
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
|
||||
DOT_FONTPATH =
|
||||
CLASS_GRAPH = YES
|
||||
COLLABORATION_GRAPH = NO # Default: YES
|
||||
GROUP_GRAPHS = NO # Default: YES
|
||||
UML_LOOK = NO
|
||||
UML_LIMIT_NUM_FIELDS = 10
|
||||
UML_MAX_EDGE_LABELS = 10
|
||||
DOT_UML_DETAILS = NO
|
||||
DOT_WRAP_THRESHOLD = 17
|
||||
TEMPLATE_RELATIONS = NO
|
||||
INCLUDE_GRAPH = NO # Default: YES
|
||||
INCLUDED_BY_GRAPH = NO # Default: YES
|
||||
@@ -572,16 +627,21 @@ CALL_GRAPH = NO
|
||||
CALLER_GRAPH = NO
|
||||
GRAPHICAL_HIERARCHY = NO # TODO: Default: YES
|
||||
DIRECTORY_GRAPH = NO # Default: YES
|
||||
DIR_GRAPH_MAX_DEPTH = 1
|
||||
DOT_IMAGE_FORMAT = $(DOT_IMAGE_FORMAT)
|
||||
INTERACTIVE_SVG = NO
|
||||
DOT_PATH =
|
||||
DOTFILE_DIRS =
|
||||
MSCFILE_DIRS =
|
||||
DIA_PATH =
|
||||
DIAFILE_DIRS =
|
||||
PLANTUML_JAR_PATH =
|
||||
PLANTUML_CFG_FILE =
|
||||
PLANTUML_INCLUDE_PATH =
|
||||
PLANTUMLFILE_DIRS =
|
||||
DOT_GRAPH_MAX_NODES = 150 # Default 50, we currently have 108 for wxObject
|
||||
MAX_DOT_GRAPH_DEPTH = 1000 # Default: 0
|
||||
DOT_TRANSPARENT = yes
|
||||
DOT_MULTI_TARGETS = NO
|
||||
GENERATE_LEGEND = YES
|
||||
DOT_CLEANUP = YES
|
||||
MSCGEN_TOOL =
|
||||
MSCFILE_DIRS =
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="Categories" intro=""/>
|
||||
<tab type="topics" visible="yes" title="Categories" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_NAME--><title>$title | $projectname</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="$relpath$jquery.js"></script>
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
Files in this subdirectory were taken from the [Doxygen Awesome][1] CSS theme
|
||||
and are under MIT licence.
|
||||
|
||||
Doxygen Awesome Version: 2.4.2
|
||||
|
||||
[1]: https://github.com/jothepro/doxygen-awesome-css
|
||||
|
||||
@@ -1,29 +1,10 @@
|
||||
// SPDX-License-Identifier: MIT
|
||||
/**
|
||||
|
||||
Doxygen Awesome
|
||||
https://github.com/jothepro/doxygen-awesome-css
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021 - 2022 jothepro
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Copyright (c) 2021 - 2025 jothepro
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,29 +1,10 @@
|
||||
// SPDX-License-Identifier: MIT
|
||||
/**
|
||||
|
||||
Doxygen Awesome
|
||||
https://github.com/jothepro/doxygen-awesome-css
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 jothepro
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Copyright (c) 2022 - 2025 jothepro
|
||||
|
||||
*/
|
||||
|
||||
@@ -33,8 +14,8 @@ class DoxygenAwesomeFragmentCopyButton extends HTMLElement {
|
||||
this.onclick=this.copyContent
|
||||
}
|
||||
static title = "Copy to clipboard"
|
||||
static copyIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
|
||||
static successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
|
||||
static copyIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M23.04,10.322c0,-2.582 -2.096,-4.678 -4.678,-4.678l-6.918,-0c-2.582,-0 -4.678,2.096 -4.678,4.678c0,-0 0,8.04 0,8.04c0,2.582 2.096,4.678 4.678,4.678c0,-0 6.918,-0 6.918,-0c2.582,-0 4.678,-2.096 4.678,-4.678c0,-0 0,-8.04 0,-8.04Zm-2.438,-0l-0,8.04c-0,1.236 -1.004,2.24 -2.24,2.24l-6.918,-0c-1.236,-0 -2.239,-1.004 -2.239,-2.24l-0,-8.04c-0,-1.236 1.003,-2.24 2.239,-2.24c0,0 6.918,0 6.918,0c1.236,0 2.24,1.004 2.24,2.24Z"/><path d="M5.327,16.748c-0,0.358 -0.291,0.648 -0.649,0.648c0,0 0,0 0,0c-2.582,0 -4.678,-2.096 -4.678,-4.678c0,0 0,-8.04 0,-8.04c0,-2.582 2.096,-4.678 4.678,-4.678l6.918,0c2.168,0 3.994,1.478 4.523,3.481c0.038,0.149 0.005,0.306 -0.09,0.428c-0.094,0.121 -0.239,0.191 -0.392,0.191c-0.451,0.005 -1.057,0.005 -1.457,0.005c-0.238,0 -0.455,-0.14 -0.553,-0.357c-0.348,-0.773 -1.128,-1.31 -2.031,-1.31c-0,0 -6.918,0 -6.918,0c-1.236,0 -2.24,1.004 -2.24,2.24l0,8.04c0,1.236 1.004,2.24 2.24,2.24l0,-0c0.358,-0 0.649,0.29 0.649,0.648c-0,0.353 -0,0.789 -0,1.142Z" style="fill-opacity:0.6;"/></svg>`
|
||||
static successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M8.084,16.111c-0.09,0.09 -0.212,0.141 -0.34,0.141c-0.127,-0 -0.249,-0.051 -0.339,-0.141c-0.746,-0.746 -2.538,-2.538 -3.525,-3.525c-0.375,-0.375 -0.983,-0.375 -1.357,0c-0.178,0.178 -0.369,0.369 -0.547,0.547c-0.375,0.375 -0.375,0.982 -0,1.357c1.135,1.135 3.422,3.422 4.75,4.751c0.27,0.27 0.637,0.421 1.018,0.421c0.382,0 0.749,-0.151 1.019,-0.421c2.731,-2.732 10.166,-10.167 12.454,-12.455c0.375,-0.375 0.375,-0.982 -0,-1.357c-0.178,-0.178 -0.369,-0.369 -0.547,-0.547c-0.375,-0.375 -0.982,-0.375 -1.357,0c-2.273,2.273 -9.567,9.567 -11.229,11.229Z"/></svg>`
|
||||
static successDuration = 980
|
||||
static init() {
|
||||
$(function() {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +1,30 @@
|
||||
/* wxWidgets Custom Styles */
|
||||
|
||||
/* Give top navigation buttons more breathing room, matching older style */
|
||||
.sm-dox li {
|
||||
margin: 0 0.2em;
|
||||
padding: 0 0.2em;
|
||||
}
|
||||
|
||||
/* Hopefully temporary tweaks to get a better looking search icon until eventual fixes in Doxygen Awesome */
|
||||
.search-icon:before {
|
||||
width: 10px;
|
||||
height: 10px;
|
||||
}
|
||||
.search-icon:after {
|
||||
width: 2px;
|
||||
height: 5px;
|
||||
top: 16px;
|
||||
left: 11px;
|
||||
background-color: #707070;
|
||||
}
|
||||
#MSearchSelectExt.search-icon {
|
||||
width: 20px;
|
||||
height: 1.4em;
|
||||
top: 3px;
|
||||
margin-left: 6px;
|
||||
}
|
||||
|
||||
div.appearance {
|
||||
margin: 1em 0em;
|
||||
}
|
||||
@@ -44,6 +69,24 @@ td.green { color: green; }
|
||||
td.orange { color: #ff8000; }
|
||||
td.red { color: red; }
|
||||
|
||||
/* Fix up class member groups - Doxygen Awesome doesn't fix these up yet */
|
||||
.memberdecls tr.groupHeader td {
|
||||
padding-top: 1em;
|
||||
}
|
||||
.memberdecls div.groupHeader {
|
||||
box-shadow: none;
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
color: inherit;
|
||||
}
|
||||
.memberdecls td.ititle {
|
||||
border: none !important;
|
||||
color: inherit;
|
||||
}
|
||||
.memberdecls div.groupText {
|
||||
font-style: inherit;
|
||||
}
|
||||
|
||||
span.literal {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
|
||||
@@ -136,7 +136,7 @@ Controls that are not static can have wxValidator associated with them.
|
||||
@li wxStaticBox: A static, or group box for visually grouping related controls
|
||||
@li wxScrollBar: Scrollbar control
|
||||
@li wxSearchCtrl: A text input control used to initiate a search
|
||||
@li wxSpinButton: A spin or `up-down' control
|
||||
@li wxSpinButton: A spin or 'up-down' control
|
||||
@li wxSpinCtrl: A spin control - i.e. spin button and text control displaying
|
||||
an integer
|
||||
@li wxSpinCtrlDouble: A spin control - i.e. spin button and text control displaying
|
||||
@@ -830,4 +830,3 @@ Related overview: @ref overview_ipc
|
||||
@li wxSingleInstanceChecker: Check that only single program instance is running
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -141,7 +141,7 @@ longer:
|
||||
|
||||
@li Julian Smart
|
||||
@li Robert Roebling
|
||||
@li Wlodzimierz `ABX' Skiba
|
||||
@li Wlodzimierz 'ABX' Skiba
|
||||
@li Chris Elliott
|
||||
@li David Elliott
|
||||
@li Kevin Hock
|
||||
@@ -173,7 +173,7 @@ David Webster, Otto Wyss, Xiaokun Zhu, Edward Zimmermann.
|
||||
Many thanks also to AIAI for being willing to release the original version of
|
||||
wxWidgets into the public domain, and to our patient partners.
|
||||
|
||||
`Graphplace', the basis for the wxGraphLayout library, is copyright Dr. Jos
|
||||
'Graphplace', the basis for the wxGraphLayout library, is copyright Dr. Jos
|
||||
T.J. van Eijndhoven of Eindhoven University of Technology. The code has
|
||||
been used in wxGraphLayout (not in wxWidgets anymore) with his permission.
|
||||
|
||||
@@ -190,7 +190,7 @@ copyright notice and this permission notice appear in supporting
|
||||
documentation, and that the name of M.I.T. not be used in advertising or
|
||||
publicity pertaining to distribution of the software without specific,
|
||||
written prior permission. M.I.T. makes no representations about the
|
||||
suitability of this software for any purpose. It is provided ``as is''
|
||||
suitability of this software for any purpose. It is provided 'as is'
|
||||
without express or implied warranty.
|
||||
</em>
|
||||
|
||||
|
||||
@@ -321,7 +321,7 @@ conditions that should or should not hold, and print out appropriate error
|
||||
messages.
|
||||
|
||||
These can be compiled out of a non-debugging version of wxWidgets and your
|
||||
application. Using ASSERT is an example of `defensive programming': it can
|
||||
application. Using ASSERT is an example of 'defensive programming': it can
|
||||
alert you to problems later on.
|
||||
|
||||
See wxASSERT() for more info.
|
||||
@@ -410,4 +410,3 @@ of time in the long run.
|
||||
See the @ref overview_debugging for further information.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -216,7 +216,7 @@ startup, before the main window is shown.
|
||||
This sample shows the wxDialUpManager
|
||||
class. In the status bar, it displays the information gathered through its
|
||||
interface: in particular, the current connection status (online or offline) and
|
||||
whether the connection is permanent (in which case a string `LAN' appears in
|
||||
whether the connection is permanent (in which case a string 'LAN' appears in
|
||||
the third status bar field - but note that you may be on a LAN not
|
||||
connected to the Internet, in which case you will not see this) or not.
|
||||
|
||||
|
||||
@@ -58,6 +58,8 @@ wxWidgets programs.
|
||||
href="https://www.gnu.org/software/gettext/manual/html_node/The-LANGUAGE-variable.html">LANGUAGE</a>
|
||||
variable: a colon-separated list of language tags (which are, in their
|
||||
simplest form, just the language names).}
|
||||
@endDefList
|
||||
|
||||
*/
|
||||
|
||||
@see wxSystemOptions
|
||||
|
||||
@@ -40,8 +40,8 @@ fi
|
||||
#
|
||||
# Still allow using incompatible version if explicitly requested.
|
||||
if [[ -z $WX_SKIP_DOXYGEN_VERSION_CHECK ]]; then
|
||||
doxygen_version=`$DOXYGEN --version`
|
||||
doxygen_version_required=1.9.1
|
||||
doxygen_version=`$DOXYGEN --version | cut -d ' ' -f 1`
|
||||
doxygen_version_required=1.15.0
|
||||
if [[ $doxygen_version != $doxygen_version_required ]]; then
|
||||
echo "Doxygen version $doxygen_version is not officially supported."
|
||||
echo "Please use Doxygen $doxygen_version_required or export WX_SKIP_DOXYGEN_VERSION_CHECK."
|
||||
@@ -243,11 +243,7 @@ if [[ -s doxygen.log ]]; then
|
||||
topsrcdir=`cd ../.. && pwd`
|
||||
sed -i'' -e "s|$topsrcdir/||g" doxygen.log
|
||||
|
||||
# Filter out warnings from interface/wx/stc/stc.h for now, there are tons
|
||||
# of them and it's not clear what to do about them, see #25603
|
||||
if grep -q -v "interface/wx/stc/stc.h" doxygen.log; then
|
||||
echo '*** There were warnings during docs generation ***'
|
||||
fi
|
||||
echo '*** There were warnings during docs generation ***'
|
||||
else
|
||||
# Don't leave empty file lying around.
|
||||
rm doxygen.log
|
||||
|
||||
@@ -36,7 +36,7 @@ enum
|
||||
configuration file location to `~/.config/appname.conf`.
|
||||
|
||||
In combination with wxCONFIG_USE_SUBDIR, this flag changes the default
|
||||
configuration file location to ~/.config/appname/appname.conf`.
|
||||
configuration file location to `~/.config/appname/appname.conf`.
|
||||
|
||||
If neither this flag nor wxCONFIG_USE_HOME is specified, XDG-compliant
|
||||
configuration file path will be used by default, but if there is an
|
||||
@@ -1071,4 +1071,3 @@ public:
|
||||
*/
|
||||
void UpdateIfDeleted();
|
||||
};
|
||||
|
||||
|
||||
@@ -89,7 +89,7 @@ public:
|
||||
/**
|
||||
This function returns @true if either the given @a mimeType is exactly
|
||||
the same as @a wildcard or if it has the same category and the subtype of
|
||||
@a wildcard is '*'. Note that the '*' wildcard is not allowed in
|
||||
@a wildcard is "*". Note that the "*" wildcard is not allowed in
|
||||
@a mimeType itself.
|
||||
|
||||
The comparison done by this function is case insensitive so it is not
|
||||
|
||||
@@ -63,7 +63,7 @@ public:
|
||||
|
||||
|
||||
/** @class wxFontProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Property representing wxFont.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -90,7 +90,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxSystemColourProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Has dropdown list of wxWidgets system colours. Value used is
|
||||
of wxColourPropertyValue type.
|
||||
|
||||
@@ -169,7 +169,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxColourProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Allows to select a colour from the list or with colour dialog. Value used
|
||||
is of wxColourPropertyValue type.
|
||||
|
||||
@@ -195,7 +195,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxCursorProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Property representing wxCursor.
|
||||
*/
|
||||
class wxCursorProperty : public wxEnumProperty
|
||||
@@ -217,7 +217,7 @@ public:
|
||||
const wxString& wxPGGetDefaultImageWildcard();
|
||||
|
||||
/** @class wxImageFileProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Property representing image file(name).
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -250,7 +250,7 @@ public:
|
||||
|
||||
|
||||
/** @class wxMultiChoiceProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Property that manages a value resulting from wxMultiChoiceDialog. Value is
|
||||
array of strings. You can get value as array of choice values/indices by
|
||||
calling wxMultiChoiceProperty::GetValueAsArrayInt().
|
||||
@@ -306,7 +306,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxDateProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Property representing wxDateTime.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
|
||||
/** @class wxPGInDialogValidator
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Creates and manages a temporary wxTextCtrl for validation purposes.
|
||||
Uses wxPropertyGrid's current editor, if available.
|
||||
*/
|
||||
@@ -29,7 +29,7 @@ public:
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
/** @class wxStringProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Basic property with string value.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -99,7 +99,7 @@ public:
|
||||
};
|
||||
|
||||
/** @class wxNumericProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
|
||||
This is an abstract class which serves as a base class for numeric properties,
|
||||
like wxIntProperty, wxUIntProperty, wxFloatProperty.
|
||||
@@ -162,7 +162,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxIntProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Basic property with integer value.
|
||||
|
||||
Seamlessly supports 64-bit integer (wxLongLong) on overflow.
|
||||
@@ -230,7 +230,7 @@ public:
|
||||
|
||||
|
||||
/** @class wxUIntProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Basic property with unsigned integer value.
|
||||
Seamlessly supports 64-bit integer (wxULongLong) on overflow.
|
||||
|
||||
@@ -279,7 +279,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxFloatProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Basic property with double-precision floating point value.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -316,7 +316,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxBoolProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Basic property with boolean value.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -344,7 +344,7 @@ public:
|
||||
|
||||
|
||||
/** @class wxEnumProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
You can derive custom properties with choices from this class. See
|
||||
wxBaseEnumProperty for remarks.
|
||||
|
||||
@@ -425,7 +425,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxEditEnumProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
wxEnumProperty with wxString value and writable combo box editor.
|
||||
|
||||
@remarks
|
||||
@@ -473,7 +473,7 @@ public:
|
||||
|
||||
|
||||
/** @class wxFlagsProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Represents a bit set that fits in a long integer. wxBoolProperty
|
||||
sub-properties are created for editing individual bits. Textctrl is created
|
||||
to manually edit the flags as a text; a continuous sequence of spaces,
|
||||
@@ -528,7 +528,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxEditorDialogProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
|
||||
This is an abstract class which serves as a base class for the properties
|
||||
having a button triggering an editor dialog, like e.g. wxLongStringProperty,
|
||||
@@ -577,7 +577,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxFileProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Like wxLongStringProperty, but the button triggers file selector instead.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -627,7 +627,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxLongStringProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Like wxStringProperty, but has a button that triggers a small text
|
||||
editor dialog.
|
||||
|
||||
@@ -654,7 +654,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxDirProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Like wxLongStringProperty, but the button triggers directory selector
|
||||
instead.
|
||||
|
||||
@@ -681,7 +681,7 @@ protected:
|
||||
|
||||
|
||||
/** @class wxArrayStringProperty
|
||||
@ingroup classes
|
||||
@ingroup group_class_propgrid
|
||||
Property that manages a list of strings.
|
||||
|
||||
<b>Supported special attributes:</b>
|
||||
@@ -857,4 +857,3 @@ protected:
|
||||
virtual void ArrayRemoveAt( int index );
|
||||
virtual void ArraySwap( size_t first, size_t second );
|
||||
};
|
||||
|
||||
|
||||
@@ -5293,7 +5293,7 @@ public:
|
||||
void SetMarginCount(int margins);
|
||||
|
||||
/**
|
||||
How many margins are there?.
|
||||
Returns the count of margins.
|
||||
|
||||
@since 3.1.1
|
||||
*/
|
||||
|
||||
@@ -530,7 +530,7 @@ public:
|
||||
/**
|
||||
Assignment from UTF-8 string.
|
||||
|
||||
Calling `s.AssignFromUTF8(utf8, len) is equivalent to doing
|
||||
Calling `s.AssignFromUTF8(utf8, len)` is equivalent to doing
|
||||
`s = wxString::FromUTF8(utf8, len)` but may be more efficient as it can
|
||||
reuse the existing string buffer instead of always having to allocate a
|
||||
new one.
|
||||
|
||||
Reference in New Issue
Block a user