qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-01-31 05:00:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update for doxygen 1.8.16

Browse source
This commit is contained in:
Bill Currie 2020-02-11 15:20:49 +09:00
parent 3144443a82
commit fbd79963bb
98 changed files with 496 additions and 373 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

299
doc/quakeforge.dox.conf.in
View file

@ -1,4 +1,4 @@
# Doxyfile 1.8.9.1
# Doxyfile 1.8.16
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@ -17,11 +17,11 @@
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# This tag specifies the encoding used for all characters in the configuration
# file that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
@ -93,6 +93,14 @@ ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all generated output in the proper direction.
# Possible values are: None, LTR, RTL and Context.
# The default value is: None.
OUTPUT_TEXT_DIRECTION = None
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
@ -179,6 +187,16 @@ SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
# such as
# /***************
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
# Javadoc-style will behave just like regular comments and it will not be
# interpreted by doxygen.
# The default value is: NO.
JAVADOC_BANNER = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
@ -226,7 +244,12 @@ TAB_SIZE = 4
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
# newlines (in the resulting output). You can put ^^ in the value part of an
# alias to insert a newline as if a physical newline was in the original file.
# When you need a literal { or } or , in the value part of an alias you have to
# escape them by means of a backslash (\), this can lead to conflicts with the
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
ALIASES = QF=QuakeForge
@ -264,17 +287,26 @@ OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
# sources only. Doxygen will then generate output that is more tailored for that
# language. For instance, namespaces will be presented as modules, types will be
# separated into more groups, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_SLICE = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
# tries to guess whether the code is fixed or free formatted code, this is the
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is
# Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
@ -285,7 +317,7 @@ EXTENSION_MAPPING = no_extension=C
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# documentation. See https://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
@ -293,6 +325,15 @@ EXTENSION_MAPPING = no_extension=C
MARKDOWN_SUPPORT = YES
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 5.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 5
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
@ -318,7 +359,7 @@ BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
@ -343,6 +384,13 @@ IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = YES
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
@ -417,6 +465,12 @@ EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.
EXTRACT_PRIV_VIRTUAL = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
@ -437,7 +491,7 @@ EXTRACT_STATIC = @STATIC_DOC@
EXTRACT_LOCAL_CLASSES = NO
# This flag is only useful for Objective-C code. When set to YES, local methods,
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
@ -495,7 +549,7 @@ INTERNAL_DOCS = NO
# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# (including Cygwin) ands Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = NO
@ -682,7 +736,7 @@ LAYOUT_FILE =
# 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
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
@ -727,11 +781,18 @@ WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# parameter documentation, but not about the absence of documentation. If
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.
WARN_AS_ERROR = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
@ -755,7 +816,7 @@ WARN_LOGFILE =
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces.
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @TOPSRC@/include \
@ -770,7 +831,7 @@ INPUT = @TOPSRC@/include \
# 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
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
# possible encodings.
# The default value is: UTF-8.
@ -778,12 +839,17 @@ INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank the
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.c \
*.h \
@ -889,6 +955,10 @@ IMAGE_PATH = @TOPSRC@/doc \
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
INPUT_FILTER =
@ -898,6 +968,10 @@ INPUT_FILTER =
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
FILTER_PATTERNS =
@ -950,7 +1024,7 @@ INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# entity all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
@ -982,12 +1056,12 @@ SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# (see https://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
@ -1015,7 +1089,7 @@ VERBATIM_HEADERS = NO
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# compiled with the --with-libclang option.
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
@ -1028,6 +1102,16 @@ CLANG_ASSISTED_PARSING = NO
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
# were built. This is equivalent to specifying the "-p" option to a clang tool,
# such as clang-check. These options will then be passed to the parser.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
@ -1146,7 +1230,7 @@ HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
@ -1182,6 +1266,17 @@ HTML_COLORSTYLE_GAMMA = 100
HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
# are dynamically created via Javascript. If disabled, the navigation index will
# consists of multiple levels of tabs that are statically embedded in every HTML
# page. Disable this option to support browsers that do not have Javascript,
# like the Qt help browser.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_MENUS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
@ -1205,13 +1300,13 @@ HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# environment (see: https://developer.apple.com/xcode/), introduced with OSX
# 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
# genXcode/_index.html for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
@ -1250,7 +1345,7 @@ DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
@ -1326,7 +1421,7 @@ QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
@ -1334,7 +1429,7 @@ QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
@ -1343,7 +1438,7 @@ QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
@ -1351,7 +1446,7 @@ QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
@ -1359,7 +1454,7 @@ QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
@ -1452,7 +1547,7 @@ EXT_LINKS_IN_WINDOW = NO
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
@ -1464,7 +1559,7 @@ FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# https://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
@ -1491,8 +1586,8 @@ MATHJAX_FORMAT = HTML-CSS
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# MathJax from https://www.mathjax.org before deployment.
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
@ -1553,7 +1648,7 @@ SERVER_BASED_SEARCH = NO
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
# Xapian (see: https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
@ -1566,7 +1661,7 @@ EXTERNAL_SEARCH = NO
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Xapian (see: https://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
@ -1618,21 +1713,35 @@ LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
# chosen this is overwritten by pdflatex. For specific output languages the
# default can have been set differently, this depends on the implementation of
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# Note: This tag is used in the Makefile / make.bat.
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
# (.tex).
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX. In case there is no backslash (\) as first character
# it will be automatically added in the LaTeX code.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
@ -1651,9 +1760,12 @@ COMPACT_LATEX = YES
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. To get the times font for
# instance you can specify
# EXTRA_PACKAGES=times
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
@ -1750,12 +1862,28 @@ LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
# LATEX_OUTPUT directory will be used.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
@ -1795,9 +1923,9 @@ COMPACT_RTF = NO
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
# file, i.e. a series of assignments. You only have to provide replacements,
# missing definitions are set to their default value.
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
@ -1806,8 +1934,8 @@ RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# similar to doxygen's configuration file. A template extensions file can be
# generated using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
@ -1893,6 +2021,13 @@ XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
# namespace members in file scope as well, matching the HTML output.
# The default value is: NO.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
@ -1925,9 +2060,9 @@ DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sf.net) file that captures the
# structure of the code including all documentation. Note that this feature is
# still experimental and incomplete at the moment.
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
@ -2101,12 +2236,6 @@ EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
@ -2120,15 +2249,6 @@ PERL_PATH = /usr/bin/perl
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
@ -2207,7 +2327,7 @@ COLLABORATION_GRAPH = YES
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = NO
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
@ -2261,7 +2381,8 @@ INCLUDED_BY_GRAPH = YES
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
@ -2272,7 +2393,8 @@ CALL_GRAPH = NO
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
@ -2295,13 +2417,17 @@ GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = NO
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot.
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
@ -2352,6 +2478,11 @@ DIAFILE_DIRS =
PLANTUML_JAR_PATH =
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml.
PLANTUML_CFG_FILE =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.

4
include/QF/alloc.h
View file

@ -37,7 +37,7 @@
/** \defgroup alloc High-tide allocator.
\ingroup utils
*/
//@{
///@{
#ifndef DEBUG_QF_MEMORY
/** High-tide structure allocator for use in linked lists.
@ -93,6 +93,6 @@
#define FREE(n, p) do { free (p); } while (0)
#endif
//@}
///@}
#endif//__QF_alloc_h

4
include/QF/cbuf.h
View file

@ -34,7 +34,7 @@
/** \defgroup cbuf Command buffer management.
\ingroup utils
*/
//@{
///@{
#include <stdarg.h>
@ -100,6 +100,6 @@ void Cbuf_Execute (cbuf_t *cbuf);
void Cbuf_Execute_Stack (cbuf_t *cbuf);
void Cbuf_Execute_Sets (cbuf_t *cbuf);
//@}
///@}
#endif//__QF_cbuf_h

4
include/QF/checksum.h
View file

@ -30,7 +30,7 @@
/** \addtogroup crc
*/
//@{
///@{
#include "QF/qtypes.h"
@ -38,6 +38,6 @@ unsigned int Com_BlockChecksum (const void *buffer, int length);
void Com_BlockFullChecksum (const void *buffer, int len, unsigned char *outbuf);
byte COM_BlockSequenceCRCByte (const byte *base, int length, int sequence);
//@}
///@}
#endif // __checksum_h

4
include/QF/cmd.h
View file

@ -31,7 +31,7 @@
/** \defgroup cmd Command management.
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
#include "QF/cbuf.h"
@ -81,6 +81,6 @@ struct cbuf_interpreter_s *Cmd_GetProvider(const char *name);
extern struct cbuf_args_s *cmd_args;
extern struct cvar_s *cmd_warncmd;
//@}
///@}
#endif//__QF_cmd_h

4
include/QF/crc.h
View file

@ -31,7 +31,7 @@
/** \defgroup crc Checksum generation.
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -41,6 +41,6 @@ void CRC_ProcessBlock (const byte *start, unsigned short *crcvalue, int count);
unsigned short CRC_Value(unsigned short crcvalue) __attribute__((const));
unsigned short CRC_Block (const byte *start, int count) __attribute__((pure));
//@}
///@}
#endif // __crc_h

8
include/QF/cvar.h
View file

@ -31,7 +31,7 @@
/** \defgroup cvar Configuration variables
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
#include "QF/quakeio.h"
@ -72,7 +72,7 @@ typedef struct cvar_alias_s {
code goes "look, the user made fs_basepath already", uses the users value,
but sets CVAR_ROM as per the call.
*/
//@{
///@{
#define CVAR_NONE 0 ///< normal cvar
#define CVAR_ARCHIVE 1 ///< set to cause it to be saved to
///< config.cfg
@ -85,7 +85,7 @@ typedef struct cvar_alias_s {
#define CVAR_LATCH 2048 ///< will change only when C code next does
///< a Cvar_Get(), so it can't be changed
///< (not implemented)
//@}
///@}
// Returns the Cvar if found, creates it with value if not. Description and
@ -138,6 +138,6 @@ void Cvar_Init (void);
extern cvar_t *cvar_vars;
//@}
///@}
#endif // __cvar_h

8
include/QF/draw.h
View file

@ -37,7 +37,7 @@
/** \defgroup video_renderer_draw Generic draw functions
\ingroup video_renderer
*/
//@{
///@{
#include "QF/wad.h"
@ -160,12 +160,12 @@ void Draw_FadeScreen (void);
/** Shift the screen colors.
*/
void Draw_BlendScreen (quat_t color);
//@}
///@}
/** \defgroup video_renderer_draw_qpic QPic functions
\ingroup video_renderer_draw
*/
//@{
///@{
/** Load a qpic from the filesystem.
\param path path of the file within the quake filesystem
\param alpha transparency level of the pic.
@ -232,6 +232,6 @@ void Draw_Picf (float x, float y, qpic_t *pic);
\param height vertical size of the sub-region to be drawn
*/
void Draw_SubPic(int x, int y, qpic_t *pic, int srcx, int srcy, int width, int height);
//@}
///@}
#endif // _DRAW_H

20
include/QF/dstring.h
View file

@ -31,7 +31,7 @@
/** \defgroup dstring Dynamic Strings
\ingroup utils
*/
//@{
///@{
#include <stdarg.h>
#include <stdlib.h>
@ -52,13 +52,13 @@ typedef struct dstring_s {
extern dstring_mem_t dstring_default_mem;
// General buffer functions
//@{
///@{
/** Create a new dstring. size and truesize start at 0 and no string buffer
is allocated.
*/
dstring_t *_dstring_new (dstring_mem_t *mem);
dstring_t *dstring_new (void);
//@}
///@}
/** Delete a dstring. Both the string buffer and dstring object are freed.
*/
void dstring_delete (dstring_t *dstr);
@ -103,13 +103,13 @@ void dstring_replace (dstring_t *dstr, unsigned int pos, unsigned int rlen,
char *dstring_freeze (dstring_t *dstr);
// String-specific functions
//@{
///@{
/** Allocate a new dstring pre-initialized as a null terminated string. size
will be 1 and the first byte 0.
*/
dstring_t *_dstring_newstr (dstring_mem_t *mem);
dstring_t *dstring_newstr (void);
//@}
///@}
/** Create a new dstring from a string. Similar to strdup().
\param str the string to copy
\return inititialized dstring
@ -160,21 +160,21 @@ void dstring_insertsubstr (dstring_t *dstr, unsigned int pos, const char *str,
*/
void dstring_clearstr (dstring_t *dstr);
//@{
///@{
/** Formatted printing to dstrings. Existing data is replaced by the formatted
string.
*/
int dvsprintf (dstring_t *dstr, const char *fmt, va_list args) __attribute__((format(printf,2,0)));
int dsprintf (dstring_t *dstr, const char *fmt, ...) __attribute__((format(printf,2,3)));
//@}
//@{
///@}
///@{
/** Formatted printing to dstrings. Formatted string is appened to the dstring.
Embedded nulls in the dstring are ignored.
*/
int davsprintf (dstring_t *dstr, const char *fmt, va_list args) __attribute__((format(printf,2,0)));
int dasprintf (dstring_t *dstr, const char *fmt, ...) __attribute__((format(printf,2,3)));
//@}
///@}
//@}
///@}
#endif // __dstring_h

4
include/QF/hash.h
View file

@ -34,7 +34,7 @@
/** \defgroup hash Hash tables
\ingroup utils
*/
//@{
///@{
typedef struct hashtab_s hashtab_t;
@ -209,6 +209,6 @@ void **Hash_GetList (hashtab_t *tab);
*/
void Hash_Stats (hashtab_t *tab);
//@}
///@}
#endif // __hash_h

4
include/QF/idparse.h
View file

@ -33,7 +33,7 @@
/** \addtogroup cbuf
*/
//@{
///@{
extern const char *com_token;
@ -44,6 +44,6 @@ void COM_TokenizeString (const char *str, struct cbuf_args_s *args);
extern struct cbuf_interpreter_s id_interp;
//@}
///@}
#endif//__QF_idparse_h

4
include/QF/info.h
View file

@ -31,7 +31,7 @@
/** \defgroup info Info Keys
\ingroup utils
*/
//@{
///@{
#include <stdlib.h> // for size_t. sys/types.h SHOULD be used, but can't :(bc)
#include <QF/qtypes.h>
@ -63,6 +63,6 @@ void Info_Destroy (info_t *info);
char *Info_MakeString (info_t *info, int (*filter)(const char *));
void Info_AddKeys (info_t *info, info_t *keys);
//@}
///@}
#endif // _INFO_H

4
include/QF/keys.h
View file

@ -39,7 +39,7 @@
/** \defgroup input_keybinding Key Binding Sub-system
\ingroup input
*/
//@{
///@{
/// these are the key numbers that should be passed to Key_Event
typedef enum {
@ -659,6 +659,6 @@ struct progs_s;
void Key_Progs_Init (struct progs_s *pr);
#endif
//@}
///@}
#endif // _KEYS_H

4
include/QF/math/dual.h
View file

@ -34,7 +34,7 @@
/** \defgroup mathlib_dual Dual and dual quaternion functions
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -189,6 +189,6 @@
} while (0)
#define DualQuatExpand(dq) QuatExpand ((dq).q0.q), QuatExpand ((dq).qe.q)
//@}
///@}
#endif // __QF_math_dual_h

4
include/QF/math/half.h
View file

@ -34,7 +34,7 @@
/** \defgroup mathlib_half Half-float functions
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -42,6 +42,6 @@
int16_t FloatToHalf (float x) __attribute__((const));
float HalfToFloat (int16_t x) __attribute__((const));
//@}
///@}
#endif // __QF_math_half_h

4
include/QF/math/matrix3.h
View file

@ -34,7 +34,7 @@
/** \defgroup mathlib_matrix3 3x3 matrix functions
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -118,6 +118,6 @@ void Mat3SymEigen (const mat3_t m, vec3_t e);
*/
int Mat3Decompose (const mat4_t mat, quat_t rot, vec3_t shear, vec3_t scale);
//@}
///@}
#endif // __QF_math_matrix3_h

4
include/QF/math/matrix4.h
View file

@ -34,7 +34,7 @@
/** \defgroup mathlib_matrix4 4x4 matrix functions
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -130,6 +130,6 @@ void Mat4as3MultVec (const mat4_t a, const vec3_t b, vec3_t c);
int Mat4Decompose (const mat4_t mat, quat_t rot, vec3_t shear, vec3_t scale,
vec3_t trans);
//@}
///@}
#endif // __QF_math_matrix4_h

4
include/QF/math/quaternion.h
View file

@ -34,7 +34,7 @@
/** \defgroup mathlib_quaternion Quaternion functions
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -168,6 +168,6 @@ void QuatInverse (const quat_t in, quat_t out);
void QuatExp (const quat_t a, quat_t b);
void QuatToMatrix (const quat_t q, vec_t *m, int homogenous, int vertical);
//@}
///@}
#endif // __QF_math_quaternion_h

4
include/QF/math/vector.h
View file

@ -31,7 +31,7 @@
/** \defgroup mathlib_vector Vector functions
\ingroup mathlib
*/
//@{
///@{
#include "QF/qtypes.h"
@ -209,6 +209,6 @@ VectorNormalize (vec3_t v)
return length;
}
//@}
///@}
#endif // __QF_math_vector_h

4
include/QF/mathlib.h
View file

@ -31,7 +31,7 @@
/** \defgroup mathlib Vector and matrix functions
\ingroup utils
*/
//@{
///@{
#include <math.h>
#include "QF/qtypes.h"
@ -218,6 +218,6 @@ int CircumSphere (const vec3_t points[], int num_points, sphere_t *sphere);
void BarycentricCoords (const vec_t **points, int num_points, const vec3_t p,
vec_t *lambda);
//@}
///@}
#endif // __mathlib_h

4
include/QF/mdfour.h
View file

@ -31,7 +31,7 @@
/** \addtogroup crc
*/
//@{
///@{
#include "QF/uint32.h"
@ -47,6 +47,6 @@ void mdfour_update(struct mdfour *md, const unsigned char *in, int n); //old: MD
void mdfour_result(struct mdfour *md, unsigned char *out); // old: MD4Final
void mdfour(unsigned char *out, const unsigned char *in, int n);
//@}
///@}
#endif // __mdfour_h

4
include/QF/msg.h
View file

@ -30,7 +30,7 @@
/** \defgroup msg Message reading and writing
\ingroup utils
*/
//@{
///@{
#include "QF/sizebuf.h"
@ -249,6 +249,6 @@ void MSG_ReadAngle16V (qmsg_t *msg, vec3_t angles);
*/
int MSG_ReadUTF8 (qmsg_t *msg);
//@}
///@}
#endif

4
include/QF/pak.h
View file

@ -33,7 +33,7 @@
/** \addtogroup pak
*/
//@{
///@{
// little-endian PACK
#define IDPAKHEADER (('K'<<24)+('C'<<16)+('A'<<8)+'P')
@ -51,6 +51,6 @@ typedef struct {
int dirlen;
} dpackheader_t;
//@}
///@}
#endif//__qf_pak_h

4
include/QF/pakfile.h
View file

@ -33,7 +33,7 @@
/** \defgroup pak pakfile proccessing
\ingroup utils
*/
//@{
///@{
#include "QF/hash.h"
#include "QF/pak.h"
@ -64,6 +64,6 @@ int pack_add (pack_t *pack, const char *filename);
int pack_extract (pack_t *pack, dpackfile_t *pf);
dpackfile_t *pack_find_file (pack_t *pack, const char *filename);
//@}
///@}
#endif//__QF_pakfile_h

4
include/QF/plugin.h
View file

@ -31,7 +31,7 @@
/** \defgroup plugin Plugins
\ingroup utils
*/
//@{
///@{
#define QFPLUGIN_VERSION "1.0"
@ -111,6 +111,6 @@ void PI_Shutdown (void);
// FIXME: we need a generic function to initialize unused fields
//@}
///@}
#endif // __QF_plugin_h_

4
include/QF/pr_type.h
View file

@ -36,7 +36,7 @@
All \c pointer_t \c type fields are pointers within the type qfo_space.
*/
//@{
///@{
#include "QF/pr_comp.h"
@ -102,6 +102,6 @@ typedef struct qfot_type_encodings_s {
pr_int_t size;
} qfot_type_encodings_t;
//@}
///@}
#endif//__pr_type_h

73
include/QF/progs.h
View file

@ -39,18 +39,18 @@
struct QFile_s;
/** \ingroup progs */
//@{
///@{
typedef struct progs_s progs_t;
typedef struct pr_resource_s pr_resource_t;
typedef struct edict_s edict_t;
//@}
///@}
//============================================================================
/** \defgroup progs_misc Miscelaneous functions
\ingroup progs
*/
//@{
///@{
/** Initialize the progs engine.
*/
@ -63,12 +63,12 @@ void PR_Init_Cvars (void);
void PR_Error (progs_t *pr, const char *error, ...) __attribute__((format(printf,2,3), noreturn));
void PR_RunError (progs_t *pr, const char *error, ...) __attribute__((format(printf,2,3), noreturn));
//@}
///@}
/** \defgroup progs_execution Execution
\ingroup progs
*/
//@{
///@{
/** Ensure P_* macros point to the right place for passing parameters to progs
functions.
@ -128,12 +128,12 @@ void PR_ExecuteProgram (progs_t *pr, func_t fnum);
*/
int PR_CallFunction (progs_t *pr, func_t fnum);
//@}
///@}
/** \defgroup progs_load Loading
\ingroup progs
*/
//@{
///@{
/** Type of functions that are called at progs load.
\param pr pointer to ::progs_t VM struct
@ -204,12 +204,12 @@ int PR_Check_Opcodes (progs_t *pr);
void PR_BoundsCheckSize (progs_t *pr, pointer_t addr, unsigned size);
void PR_BoundsCheck (progs_t *pr, int addr, etype_t type);
//@}
///@}
/** \defgroup progs_edict Edict management
\ingroup progs
*/
//@{
///@{
struct edict_s {
qboolean free;
@ -261,13 +261,13 @@ void ED_EntityParseFunction (progs_t *pr);
# define NUM_FOR_EDICT(p,e) ED_NumForEdict (p, e)
#endif
//@}
///@}
/** \defgroup pr_symbols Symbol Management
\ingroup progs
Lookup functions for symbol name resolution.
*/
//@{
///@{
ddef_t *PR_FieldAtOfs (progs_t *pr, pr_int_t ofs) __attribute__((pure));
ddef_t *PR_GlobalAtOfs (progs_t *pr, pr_int_t ofs) __attribute__((pure));
@ -282,7 +282,7 @@ int PR_AccessField (progs_t *pr, const char *name, etype_t type,
const char *file, int line);
void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute__((noreturn));
//@}
///@}
//============================================================================
@ -296,7 +296,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
Typed global access macros. No checking is done against the QC type, but
the appropriate C type will be used.
*/
//@{
///@{
/** \internal
\param p pointer to ::progs_t VM struct
@ -479,14 +479,14 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
\hideinitializer
*/
#define G_STRUCT(p,t,o) (*(t *)G_GPOINTER (p, o))
//@}
///@}
/** \defgroup prda_parameters Parameters
\ingroup progs_data_access
Typed parameter access macros. No checking is done against the QC type, but
the appropriate C type will be used.
*/
//@{
///@{
/** \internal
\param p pointer to ::progs_t VM struct
@ -669,7 +669,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
\hideinitializer
*/
#define P_STRUCT(p,t,n) (*(t *)P_GPOINTER (p, n))
//@}
///@}
/** \defgroup prda_return Return Values
\ingroup progs_data_access
@ -680,7 +680,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
ask for an \c int from a function that returned a \c float, you're asking
for trouble.
*/
//@{
///@{
/** \internal
\param p pointer to ::progs_t VM struct
@ -836,14 +836,14 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
\hideinitializer
*/
#define RETURN_QUAT(p,q) VectorCopy (q, R_QUAT (p))
//@}
///@}
/** \defgroup prda_entity_fields Entity Fields
\ingroup progs_data_access
Typed entity field access macros. No checking is done against the QC type,
but the appropriate C type will be used.
*/
//@{
///@{
/** \internal
\param e pointer to the entity
@ -980,7 +980,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
\hideinitializer
*/
#define E_DSTRING(p,e,o) (PR_GetMutableString (p, E_STRING (e, o)))
//@}
///@}
/** \defgroup pr_builtins VM Builtin functions
\ingroup progs
@ -993,7 +993,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
0x8000000 to 0xffffffff is unavailable due to the builtin number being
a negative statement address.
*/
//@{
///@{
#define PR_RANGE_SHIFT 16
#define PR_RANGE_MASK 0xffff0000
@ -1067,7 +1067,7 @@ builtin_t *PR_FindBuiltinNum (progs_t *pr, pr_int_t num);
*/
int PR_RelocateBuiltins (progs_t *pr);
//@}
///@}
/** \defgroup pr_strings String Management
\ingroup progs
@ -1093,7 +1093,7 @@ int PR_RelocateBuiltins (progs_t *pr);
They can be created, altered, and destroyed at any time by the main
program (or the progs code via an appropriate builtin function).
*/
//@{
///@{
/** Initialize the string tables using the strings supplied by the progs.
Called automatically during progs load.
@ -1254,13 +1254,13 @@ void PR_FreeTempStrings (progs_t *pr);
void PR_Sprintf (progs_t *pr, struct dstring_s *result, const char *name,
const char *format, int count, pr_type_t **args);
//@}
///@}
/** \defgroup pr_resources Resource Management
\ingroup progs
Builtin module private data management.
*/
//@{
///@{
/** Initialize the resource management fields.
@ -1314,7 +1314,7 @@ void *PR_Resources_Find (progs_t *pr, const char *name);
\note \p map is the resource map itself, not a pointer to the
resource map.
*/
//@{
///@{
/** Type delcaration for the resource map.
@ -1416,29 +1416,30 @@ void *PR_Resources_Find (progs_t *pr, const char *name);
return ~(i * 1024 + d); \
} \
return 0
//@}
///@}
//@}
///@}
/** \defgroup pr_zone VM memory management.
\ingroup progs
Used to allocate and free memory in the VM address space.
*/
//@{
///@{
void PR_Zone_Init (progs_t *pr);
void PR_Zone_Free (progs_t *pr, void *ptr);
void *PR_Zone_Malloc (progs_t *pr, pr_int_t size);
void *PR_Zone_Realloc (progs_t *pr, void *ptr, pr_int_t size);
//@}
///@}
/** \defgroup debug VM Debugging
\ingroup progs
Progs debugging support.
*/
//@{
/// \addtogroup debug
///@{
void PR_Debug_Init (void);
void PR_Debug_Init_Cvars (void);
@ -1464,20 +1465,20 @@ extern struct cvar_s *pr_deadbeef_locals;
extern struct cvar_s *pr_boundscheck;
extern struct cvar_s *pr_faultchecks;
//@}
///@}
/** \defgroup pr_cmds Quake and Quakeworld common builtins
\ingroup progs
\todo This really doesn't belong in progs.
*/
//@{
///@{
char *PF_VarString (progs_t *pr, int first);
void PR_Cmds_Init (progs_t *pr);
extern const char *pr_gametype;
//@}
///@}
//============================================================================
@ -1682,7 +1683,7 @@ struct progs_s {
/** \addtogroup progs_data_access
*/
//@{
///@{
/** Convert a progs offset/pointer to a C pointer.
\param pr pointer to ::progs_t VM struct
@ -1706,7 +1707,7 @@ PR_SetPointer (progs_t *pr, void *p)
return p ? (pr_type_t *) p - pr->pr_globals : 0;
}
//@}
///@}
/** \example vm-exec.c
*/

4
include/QF/qargs.h
View file

@ -32,7 +32,7 @@
/** \addtogroup misc
*/
//@{
///@{
#include "QF/qtypes.h"
@ -50,6 +50,6 @@ void COM_Init_Cvars (void);
void COM_InitArgv (int argc, const char **argv);
void COM_ParseConfig (void);
//@}
///@}
#endif // __qargs_h

4
include/QF/qendian.h
View file

@ -33,7 +33,7 @@
/** \defgroup qendian Endian handling functions
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -118,6 +118,6 @@ byte ReadByte (struct QFile_s *file);
unsigned short ReadShort (struct QFile_s *file);
unsigned int ReadLong (struct QFile_s *file);
//@}
///@}
#endif // __qendian_h

4
include/QF/qfplist.h
View file

@ -31,7 +31,7 @@
/** \defgroup qfplist Property lists
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
@ -226,6 +226,6 @@ plitem_t *PL_NewString (const char *str);
*/
void PL_Free (plitem_t *item);
//@}
///@}
#endif // __QF_qfplist_h_

4
include/QF/quakefs.h
View file

@ -33,7 +33,7 @@
/** \defgroup quakefs Quake Filesystem
\ingroup utils
*/
//@{
///@{
#include "QF/qtypes.h"
#include "QF/quakeio.h"
@ -418,6 +418,6 @@ void QFS_FilelistFill (filelist_t *list, const char *path, const char *ext,
*/
void QFS_FilelistFree (filelist_t *list);
//@}
///@}
#endif // __quakefs_h

4
include/QF/quakeio.h
View file

@ -34,7 +34,7 @@
/** \defgroup quakeio File IO
\ingroup utils
*/
//@{
///@{
typedef struct QFile_s QFile;
@ -60,6 +60,6 @@ int Qflush(QFile *file);
int Qeof(QFile *file);
const char *Qgetline(QFile *file);
//@}
///@}
#endif /*__quakeio_h*/

4
include/QF/script.h
View file

@ -25,7 +25,7 @@
Line oriented script parsing. Multiple scripts being parsed at the same
time is supported.
*/
//@{
///@{
#include "QF/qtypes.h"
@ -97,6 +97,6 @@ void Script_UngetToken (script_t *script);
*/
const char *Script_Token (script_t *script) __attribute__((pure));
//@}
///@}
#endif//__QF_script_h

4
include/QF/set.h
View file

@ -36,7 +36,7 @@
/** \defgroup set Set handling
\ingroup utils
*/
//@{
///@{
//FIXME other archs
#ifdef __x86_64__
@ -370,5 +370,5 @@ set_iter_t *set_next_r (set_pool_t *set_pool, set_iter_t *set_iter);
*/
const char *set_as_string (const set_t *set);
//@}
///@}
#endif//__QF_set_h

4
include/QF/sizebuf.h
View file

@ -31,7 +31,7 @@
\ingroup utils
Fixed size buffer management
*/
//@{
///@{
#include "QF/qtypes.h"
@ -51,6 +51,6 @@ void *SZ_GetSpace (sizebuf_t *buf, int length);
void SZ_Write (sizebuf_t *buf, const void *data, int length);
void SZ_Print (sizebuf_t *buf, const char *data); // strcats onto the sizebuf
//@}
///@}
#endif // __sizebuf_h

12
include/QF/sound.h
View file

@ -37,7 +37,7 @@
/**
\ingroup sound
*/
//@{
///@{
typedef struct sfx_s sfx_t;
struct sfx_s
{
@ -62,14 +62,14 @@ struct sfx_s
sfx_t *(*open) (sfx_t *sfx);
void (*close) (sfx_t *sfx);
};
//@}
///@}
struct model_s;
/** \defgroup sound_init Initialization functions
\ingroup sound
*/
//@{
///@{
/** Initialize the sound engine.
\param viewentity pointer to view entity index
@ -81,12 +81,12 @@ void S_Init (int *viewentity, double *host_frametime);
*/
void S_Init_Cvars (void);
//@}
///@}
/** \defgroup sound_stuff Unclassified
\ingroup sound
*/
//@{
///@{
/** Start a sound playing.
\param entnum index of entity the sound is associated with.
@ -189,6 +189,6 @@ void S_AmbientOn (void);
struct progs_s;
void S_Progs_Init (struct progs_s *pr);
//@}
///@}
#endif // _SOUND_H

4
include/QF/sys.h
View file

@ -32,7 +32,7 @@
\ingroup utils
Non-portable functions
*/
//@{
///@{
#include <stdio.h>
#include <stdint.h>
@ -159,6 +159,6 @@ int Sys_CreatePath (const char *path);
*/
char *Sys_ExpandSquiggle (const char *path);
//@}
///@}
#endif // __sys_h

4
include/QF/va.h
View file

@ -32,13 +32,13 @@
/** \addtogroup misc
Formatted printing.
*/
//@{
///@{
// does a varargs printf into a temp buffer
char *va(const char *format, ...) __attribute__((format(printf,1,2)));
// does a varargs printf into a malloced buffer
char *nva(const char *format, ...) __attribute__((format(printf,1,2)));
//@}
///@}
#endif // __va_h

4
include/QF/ver_check.h
View file

@ -34,7 +34,7 @@
/** \defgroup misc Miscellaneous functions
\ingroup utils
*/
//@{
///@{
/*
ver_compare
@ -45,6 +45,6 @@
*/
int ver_compare (const char *, const char *);
//@}
///@}
#endif // __ver_check_h_

4
include/QF/view.h
View file

@ -34,7 +34,7 @@
/** \defgroup console_view Console View Objects
\ingroup console
*/
//@{
///@{
/** Control the positioning of a view within its parent. The directions are
the standard compass rose (north, east, south, west in clockwise order)
@ -215,6 +215,6 @@ void view_resize (view_t *view, int xl, int yl);
*/
void view_move (view_t *view, int xp, int yp);
//@}
///@}
#endif//__qf_view_h

4
include/QF/wad.h
View file

@ -32,7 +32,7 @@
/** \addtogroup wad
Wad Files
*/
//@{
///@{
#include "QF/wadfile.h"
@ -46,6 +46,6 @@ void *W_GetLumpName (const char *name);
void SwapPic (qpic_t *pic);
//@}
///@}
#endif // _WAD_H

4
include/QF/wadfile.h
View file

@ -29,7 +29,7 @@
\ingroup utils
Wadfile processing
*/
//@{
///@{
#ifndef __QF_wadfile_h
#define __QF_wadfile_h
@ -102,6 +102,6 @@ int wad_add_data (wad_t *wad, const char *lumpname, byte type,
const void *data, int bytes);
lumpinfo_t *wad_find_lump (wad_t *wad, const char *filename);
//@}
///@}
#endif//__QF_wadfile_h

4
include/QF/winding.h
View file

@ -26,7 +26,7 @@
/** \defgroup winding Winding Manipulation
*/
//@{
///@{
struct plane_s;
@ -138,6 +138,6 @@ winding_t *ClipWinding (winding_t *in, struct plane_s *split, qboolean keepon);
void DivideWinding (winding_t *in, struct plane_s *split,
winding_t **front, winding_t **back);
//@}
///@}
#endif//__QF_winding_h

4
include/QF/zone.h
View file

@ -88,7 +88,7 @@
----- Bottom of Memory -----
*/
//@{
///@{
typedef struct memzone_s memzone_t;
@ -140,6 +140,6 @@ void *Cache_Get (cache_user_t *c);
void Cache_Release (cache_user_t *c);
int Cache_ReadLock (cache_user_t *c) __attribute__((pure));
//@}
///@}
#endif // __zone_h

4
include/net_dgrm.h
View file

@ -29,7 +29,7 @@
/** \defgroup nq-dgrm NetQuake Datagram network driver.
\ingroup nq-nd
*/
//@{
///@{
/** Initialize the Datagram net driver.
@ -125,4 +125,4 @@ void Datagram_Close (qsocket_t *sock);
*/
void Datagram_Shutdown (void);
//@}
///@}

4
include/net_loop.h
View file

@ -34,7 +34,7 @@
/** \defgroup nq-loop NetQuake loopback network driver.
\ingroup nq-nd
*/
//@{
///@{
int Loop_Init (void);
void Loop_Listen (qboolean state);
@ -49,6 +49,6 @@ qboolean Loop_CanSendUnreliableMessage (qsocket_t *sock);
void Loop_Close (qsocket_t *sock);
void Loop_Shutdown (void);
//@}
///@}
#endif//__net_loop_h

4
include/net_udp.h
View file

@ -33,7 +33,7 @@
/** \defgroup nq-udp NetQuake UDP lan driver.
\ingroup nq-ld
*/
//@{
///@{
/** Initialize the UDP network interface.
@ -193,6 +193,6 @@ int UDP_GetSocketPort (netadr_t *addr);
*/
int UDP_SetSocketPort (netadr_t *addr, int port);
//@}
///@}
#endif // __net_udp_h

4
include/net_vcr.h
View file

@ -29,7 +29,7 @@
/** \defgroup nq-vcr NetQuake VCR network driver.
\ingroup nq-nd
*/
//@{
///@{
#define VCR_OP_CONNECT 1
#define VCR_OP_GETMESSAGE 2
@ -48,4 +48,4 @@ qboolean VCR_CanSendMessage (qsocket_t *sock);
void VCR_Close (qsocket_t *sock);
void VCR_Shutdown (void);
//@}
///@}

4
include/net_wins.h
View file

@ -35,7 +35,7 @@
/** \defgroup nq-wins NetQuake Winsock lan driver.
\ingroup nq-ld
*/
//@{
///@{
extern int winsock_initialized;
extern WSADATA winsockdata;
@ -58,6 +58,6 @@ int WINS_AddrCompare (netadr_t *addr1, netadr_t *addr2);
int WINS_GetSocketPort (netadr_t *addr);
int WINS_SetSocketPort (netadr_t *addr, int port);
//@}
///@}
#endif//__net_wins_h

12
include/netchan.h
View file

@ -39,7 +39,7 @@
/** \defgroup qw-net QuakeWorld network support.
\ingroup network
*/
//{
///@{
#define MAX_MSGLEN 1450 ///< max length of a reliable message
#define MAX_DATAGRAM 1450 ///< max length of unreliable message
@ -75,12 +75,12 @@ void Analyze_Client_Packet (const byte * data, int len, int has_sequence);
void Analyze_Server_Packet (const byte * data, int len, int has_sequence);
extern struct cvar_s *net_packetlog;
//@}
///@}
/** \defgroup qw-udp QuakeWorld udp support.
\ingroup qw-net
*/
//@{
///@{
/** Initialize the UDP network interface.
@ -161,7 +161,7 @@ const char *NET_BaseAdrToString (netadr_t a);
*/
qboolean NET_StringToAdr (const char *s, netadr_t *a);
//@}
///@}
/** \defgroup netchan Netchan
\ingroup qw-net
@ -216,7 +216,7 @@ qboolean NET_StringToAdr (const char *s, netadr_t *a);
the channel matches even if the IP port differs. The IP port should be
updated to the new value before sending out any replies.
*/
//@{
///@{
#define OLD_AVG 0.99 // total = oldtotal*OLD_AVG + new*(1-OLD_AVG)
#define MAX_LATENT 32
@ -377,6 +377,6 @@ qboolean Netchan_CanReliable (netchan_t *chan) __attribute__((pure));
*/
void Netchan_SendPacket (int length, const void *data, netadr_t to);
//@}
///@}
#endif // _NET_H

28
include/netmain.h
View file

@ -34,7 +34,7 @@
/** \defgroup nq-net NetQuake network support.
\ingroup network
*/
//@{
///@{
typedef struct
{
@ -56,7 +56,7 @@ typedef struct
/** \name NetHeader flags
*/
//@{
///@{
#define NETFLAG_LENGTH_MASK 0x0000ffff
#define NETFLAG_DATA 0x00010000
#define NETFLAG_ACK 0x00020000
@ -64,7 +64,7 @@ typedef struct
#define NETFLAG_EOM 0x00080000
#define NETFLAG_UNRELIABLE 0x00100000
#define NETFLAG_CTL 0x80000000
//@}
///@}
#define NET_PROTOCOL_VERSION 3
@ -86,7 +86,7 @@ typedef struct
a full address and port in a string. It is used for returning the
address of a server that is not running locally.
*/
//@{
///@{
/** Connect Request:
\arg \b string \c game_name \em "QUAKE"
@ -153,7 +153,7 @@ typedef struct
\arg \b string \c value
*/
#define CCREP_RULE_INFO 0x85
//@}
///@}
typedef struct qsocket_s {
struct qsocket_s *next;
@ -205,11 +205,11 @@ typedef struct qsocket_s {
/** \name socket management
*/
//@{
///@{
extern qsocket_t *net_activeSockets;
extern qsocket_t *net_freeSockets;
extern int net_numsockets;
//@}
///@}
#define MAX_NET_DRIVERS 8
@ -220,12 +220,12 @@ extern int net_driverlevel;
/** \name message statistics
*/
//@{
///@{
extern int messagesSent;
extern int messagesReceived;
extern int unreliableMessagesSent;
extern int unreliableMessagesReceived;
//@}
///@}
/** Create and initialize a new qsocket.
@ -386,12 +386,12 @@ extern struct cvar_s *hostname;
extern QFile *vcrFile;
//@}
///@}
/** \defgroup nq-ld NetQuake lan drivers.
\ingroup nq-net
*/
//@{
///@{
typedef struct {
const char *name;
@ -419,12 +419,12 @@ typedef struct {
extern int net_numlandrivers;
extern net_landriver_t net_landrivers[MAX_NET_DRIVERS];
//@}
///@}
/** \defgroup nq-nd NetQuake network drivers.
\ingroup nq-net
*/
//@{
///@{
typedef struct {
const char *name;
@ -447,6 +447,6 @@ typedef struct {
extern int net_numdrivers;
extern net_driver_t net_drivers[MAX_NET_DRIVERS];
//@}
///@}
#endif // __net_h

28
include/snd_internal.h
View file

@ -35,7 +35,7 @@
/** \defgroup sound_render Sound rendering sub-system.
\ingroup sound
*/
//@{
///@{
#include "QF/plugin/general.h"
#include "QF/plugin/snd_render.h"
@ -234,12 +234,12 @@ extern snd_render_data_t snd_render_data;
#define PAINTBUFFER_SIZE 512
extern portable_samplepair_t snd_paintbuffer[PAINTBUFFER_SIZE * 2];
//@}
///@}
/** \defgroup sound_render_sfx Sound sfx
\ingroup sound_render_mix
*/
//@{
///@{
/** Cache sound data. Initializes caching fields of sfx.
\param sfx
\param realname
@ -289,7 +289,7 @@ sfx_t *SND_LoadSound (const char *name);
*/
void SND_SFX_Init (void);
//@}
///@}
/** \defgroup sound_render_mix_channels Sound channels
\ingroup sound_render_mix
@ -302,7 +302,7 @@ void SND_SFX_Init (void);
- MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels - 1 <br>
static sounds
*/
//@{
///@{
#define MAX_CHANNELS 512 //!< number of available mixing channels
#define MAX_DYNAMIC_CHANNELS 128 //!< number of dynamic channels
#define MAX_STATIC_CHANNELS 256 //!< number of static channels
@ -390,13 +390,13 @@ void SND_StopSound (int entnum, int entchannel);
\param s name of sound to play
*/
void SND_LocalSound (const char *s);
//@}
///@}
/** \defgroup sound_render_mix Mixer engine.
\ingroup sound_render
*/
//@{
///@{
/** sound clock in samples
*/
extern unsigned snd_paintedtime;
@ -414,13 +414,13 @@ void SND_InitScaletable (void);
\param sc sfxbuffer to set.
*/
void SND_SetPaint (sfxbuffer_t *sc);
//@}
///@}
/** \defgroup sound_render_resample Resampling functions
\ingroup sound_render
*/
//@{
///@{
/** Set up the various parameters that depend on the actual sample rate.
\param sc buffer to setup
\param streamed non-zero if this is for a stream.
@ -448,13 +448,13 @@ void SND_Resample (sfxbuffer_t *sc, float *data, int length);
*/
void SND_Convert (byte *idata, float *fdata, int frames, int channels,
int width);
//@}
///@}
/** \defgroup sound_render_load Sound loading functions
\ingroup sound_render
*/
//@{
///@{
/** Load the referenced sound.
\param sfx sound reference
\return 0 if ok, -1 on error
@ -492,12 +492,12 @@ int SND_LoadWav (QFile *file, sfx_t *sfx, char *realname);
\return 0 if ok, -1 on error
*/
int SND_LoadMidi (QFile *file, sfx_t *sfx, char *realname);
//@}
///@}
/** \defgroup sound_render_cache_stream Cache/Stream Functions.
\ingroup sound_render
*/
//@{
///@{
/** Retrieve wavinfo from a cached sound.
\param sfx sound reference
\return pointer to sound's wavinfo
@ -579,6 +579,6 @@ void SND_StreamSetPos (sfxbuffer_t *buffer, unsigned int pos);
*/
sfxbuffer_t *SND_GetCache (long samples, int rate, int channels,
sfxblock_t *block, cache_allocator_t allocator);
//@}
///@}
#endif//__snd_internal_h

6
libs/models/winding.c
View file

@ -40,10 +40,6 @@
#define BOGUS (18000.0)
/** \addtogroup qfbsp_winding
*/
//@{
int c_activewindings, c_peakwindings;
winding_t *
@ -326,5 +322,3 @@ FreeWinding (winding_t *w)
c_activewindings--;
free (w);
}
//@}

4
qtv/include/connection.h
View file

@ -36,7 +36,7 @@
/** \defgroup qtv_connection Connection Management
\ingroup qtv
*/
//@{
///@{
typedef struct connection_s {
netadr_t address; ///< Address of the remote end.
@ -77,6 +77,6 @@ void Connection_Del (connection_t *con);
*/
connection_t *Connection_Find (netadr_t *address);
//@}
///@}
#endif//__connection_h

4
qtv/include/qtv.h
View file

@ -40,7 +40,7 @@
/** \defgroup qtv_general General Functions
\ingroup qtv
*/
//@{
///@{
#define PORT_QTV 27501 ///< Default port to listen for connecting clients.
@ -91,6 +91,6 @@ void qtv_end_redirect (void);
void qtv_sbar_init (void);
//@}
///@}
#endif//__qtv_h

4
ruamoko/include/gui/Group.h
View file

@ -4,7 +4,7 @@
#include "View.h"
/** \addtogroup gui */
//@{
///@{
@class Array;
@ -41,6 +41,6 @@
- (id) addViews: (Array*)viewlist;
@end
//@}
///@}
#endif//__ruamoko_gui_Group_h

8
ruamoko/include/gui/InputLine.h
View file

@ -8,7 +8,7 @@
Interface functions to the engine implementation.
*/
//@{
///@{
/** Opaque handle to an inputline.
@ -118,10 +118,10 @@ typedef void (il_enterfunc)(string, void*);
\return The current text of the intputline.
*/
@extern string InputLine_GetText (inputline_t il);
//@}
///@}
/** \addtogroup gui */
//@{
///@{
/** Class representation of the low-level inputline objects.
*/
@ -252,6 +252,6 @@ typedef void (il_enterfunc)(string, void*);
- (string) text;
@end
//@}
///@}
#endif //__ruamoko_gui_InputLine_h

4
ruamoko/include/gui/Pic.h
View file

@ -4,7 +4,7 @@
#include "gui/View.h"
/** \addtogroup gui */
//@{
///@{
@interface Pic : View
{
@ -18,6 +18,6 @@
-(void)draw;
@end
//@}
///@}
#endif//__ruamoko_gui_Pic_h

4
ruamoko/include/gui/Point.h
View file

@ -2,7 +2,7 @@
#define __ruamoko_gui_Point_h
/** \addtogroup gui */
//@{
///@{
struct Point {
int x;
@ -15,6 +15,6 @@ typedef struct Point Point;
@extern Point addPoint (Point a, Point b);
@extern Point subtractPoint (Point a, Point b);
//@}
///@}
#endif //__ruamoko_gui_Point_h

4
ruamoko/include/gui/Rect.h
View file

@ -5,7 +5,7 @@
#include "gui/Size.h"
/** \addtogroup gui */
//@{
///@{
struct Rect {
Point origin;
@ -30,6 +30,6 @@ typedef struct Rect Rect;
- (Rect) offsetBySize: (Size)aSize;
#endif
//@}
///@}
#endif //__ruamoko_gui_Rect_h

4
ruamoko/include/gui/Size.h
View file

@ -2,7 +2,7 @@
#define __ruamoko_gui_Size_h
/** \addtogroup gui */
//@{
///@{
struct Size {
int width;
@ -15,6 +15,6 @@ typedef struct Size Size;
@extern Size addSize (Size a, Size b);
@extern Size subtractSize (Size a, Size b);
//@}
///@}
#endif //__ruamoko_gui_Size_h

4
ruamoko/include/gui/Slider.h
View file

@ -4,7 +4,7 @@
#include "View.h"
/** \addtogroup gui */
//@{
///@{
@interface Slider: View
{
@ -19,6 +19,6 @@
@end
//@}
///@}
#endif //__ruamoko_gui_Slider_h

4
ruamoko/include/gui/Text.h
View file

@ -4,7 +4,7 @@
#include "View.h"
/** \addtogroup gui */
//@{
///@{
@interface Text: View
{
@ -18,6 +18,6 @@
- (void) draw;
@end
//@}
///@}
#endif //__ruamoko_gui_Text_h

4
ruamoko/include/gui/View.h
View file

@ -8,7 +8,7 @@
*/
/** \addtogroup gui */
//@{
///@{
/** The View class.
*/
@ -34,6 +34,6 @@
- (int) keyEvent:(int)key unicode:(int)unicode down:(int)down;
@end
//@}
///@}
#endif //__ruamoko_gui_View_h

4
tools/qfbsp/include/brush.h
View file

@ -30,7 +30,7 @@
/** \defgroup qfbsp_brush Brush Functions
\ingroup qfbsp
*/
//@{
///@{
#define NUM_HULLS 2 // normal and +16
@ -95,6 +95,6 @@ int NormalizePlane (plane_t *dp);
*/
int FindPlane (const plane_t *dplane, int *side);
//@}
///@}
#endif//qfbsp_brush_h

4
tools/qfbsp/include/bsp5.h
View file

@ -32,7 +32,7 @@
/** \defgroup qfbsp_general General functions
\ingroup qfbsp
*/
//@{
///@{
#define MAX_THREADS 4
@ -129,6 +129,6 @@ node_t *AllocNode (void);
extern bsp_t *bsp;
//@}
///@}
#endif//qfbsp_bsp5_h

4
tools/qfbsp/include/csg4.h
View file

@ -27,7 +27,7 @@
/** \defgroup qfbsp_csg4 CSG Functions
\ingroup qfbsp
*/
//@{
///@{
struct plane_s;
struct visfacet_s;
@ -84,6 +84,6 @@ struct surface_s *CSGFaces (struct brushset_s *bs);
void SplitFace (struct visfacet_s *in, struct plane_s *split,
struct visfacet_s **front, struct visfacet_s **back);
//@}
///@}
#endif//qfbsp_csg4_h

4
tools/qfbsp/include/draw.h
View file

@ -27,7 +27,7 @@
/** \defgroup qfbsp_draw Debug Drawing Functions
\ingroup qfbsp
*/
//@{
///@{
struct visfacet_s;
struct portal_s;
@ -53,6 +53,6 @@ void DrawBrush (const struct brush_s *b);
void DrawWinding (const struct winding_s *w);
void DrawTri (const vec3_t p1, const vec3_t p2, const vec3_t p3);
//@}
///@}
#endif//qfbsp_draw_h

4
tools/qfbsp/include/map.h
View file

@ -27,7 +27,7 @@
/** \defgroup qfbsp_map Map Parser
\ingroup qfbsp
*/
//@{
///@{
#define MAX_FACES 256
typedef struct mface_s {
@ -120,6 +120,6 @@ void GetVectorForKey (const entity_t *ent, const char *key, vec3_t vec);
*/
void WriteEntitiesToString (void);
//@}
///@}
#endif//qfbsp_map_h

4
tools/qfbsp/include/merge.h
View file

@ -25,7 +25,7 @@
/** \defgroup qfbsp_merge Merge Functions
\ingroup qfbsp
*/
//@{
///@{
/** Add a face to the list of faces, doing any possible merging.
@ -63,6 +63,6 @@ void MergePlaneFaces (surface_t *plane);
*/
void MergeAll (surface_t *surfhead);
//@}
///@}
#endif//qfbsp_merge_h

4
tools/qfbsp/include/options.h
View file

@ -33,7 +33,7 @@
/** \defgroup qfbsp_options Command-line Options Parsing
\ingroup qfbsp
*/
//@{
///@{
typedef struct {
int verbosity; // 0=silent
@ -65,6 +65,6 @@ extern options_t options;
int DecodeArgs (int argc, char **argv);
extern const char *this_program;
//@}
///@}
#endif//qfbsp_options_h

4
tools/qfbsp/include/outside.h
View file

@ -25,7 +25,7 @@
/** \defgroup qfbsp_outside Outside Functions
\ingroup qfbsp
*/
//@{
///@{
struct node_s;
@ -41,6 +41,6 @@ struct node_s;
*/
qboolean FillOutside (struct node_s *node);
//@}
///@}
#endif//qfbsp_outside_h

4
tools/qfbsp/include/portals.h
View file

@ -31,7 +31,7 @@
Decision nodes will not have portals on them, though as part of the
portal building process, they will temporarily have portals.
*/
//@{
///@{
struct node_s;
@ -89,6 +89,6 @@ void FreeAllPortals (struct node_s *node);
*/
void WritePortalfile (struct node_s *headnode);
//@}
///@}
#endif//qfbsp_portals_h

4
tools/qfbsp/include/readbsp.h
View file

@ -25,7 +25,7 @@
/** \defgroup qfbsp_readbsp BSP Reading Functions
\ingroup qfbsp
*/
//@{
///@{
/** Load the bspfile into memory.
*/
@ -47,6 +47,6 @@ void extract_entities (void);
*/
void extract_hull (void);
//@}
///@}
#endif//qfbsp_readbsp_h

4
tools/qfbsp/include/region.h
View file

@ -25,7 +25,7 @@
/** \defgroup qfbsp_region Region Functions
\ingroup qfbsp
*/
//@{
///@{
struct node_s;
@ -35,6 +35,6 @@ struct node_s;
*/
void GrowNodeRegions (struct node_s *headnode);
//@}
///@}
#endif//qfbsp_region_h

4
tools/qfbsp/include/solidbsp.h
View file

@ -27,7 +27,7 @@
/** \defgroup qfbsp_solidbsp BSP Creation Functions
\ingroup qfbsp
*/
//@{
///@{
struct visfacet_s;
struct plane_s;
@ -48,6 +48,6 @@ void CalcSurfaceInfo (struct surface_s *surf);
*/
struct node_s *SolidBSP (struct surface_s *surfhead, qboolean midsplit);
//@}
///@}
#endif//qfbsp_solidbsp_h

4
tools/qfbsp/include/surfaces.h
View file

@ -27,7 +27,7 @@
/** \defgroup qfbsp_surface Surface Functions
\ingroup qfbsp
*/
//@{
///@{
struct visfacet_s;
struct node_s;
@ -104,6 +104,6 @@ struct surface_s *GatherNodeFaces (struct node_s *headnode);
*/
void MakeFaceEdges (struct node_s *headnode);
//@}
///@}
#endif//surfaces_h

4
tools/qfbsp/include/tjunc.h
View file

@ -25,7 +25,7 @@
/** \defgroup qfbsp_tjunc T-Junction Repair
\ingroup qfbsp
*/
//@{
///@{
struct node_s;
@ -35,6 +35,6 @@ struct node_s;
*/
void tjunc (struct node_s *headnode);
//@}
///@}
#endif//qfbsp_tjunc_h

4
tools/qfbsp/include/writebsp.h
View file

@ -27,7 +27,7 @@
/** \defgroup qfbsp_writebsp BSP Writing Functions
\ingroup qfbsp
*/
//@{
///@{
struct node_s;
@ -78,6 +78,6 @@ void BeginBSPFile (void);
*/
void FinishBSPFile (void);
//@}
///@}
#endif//qfbsp_writebsp_h

4
tools/qfcc/include/dags.h
View file

@ -33,7 +33,7 @@
/** \defgroup qfcc_dags DAG building
\ingroup qfcc
*/
//@{
///@{
#include "QF/pr_comp.h"
@ -110,6 +110,6 @@ dag_t *dag_create (struct flownode_s *flownode);
void dag_remove_dead_nodes (dag_t *dag);
void dag_generate (dag_t *dag, sblock_t *block);
//@}
///@}
#endif//dags_h

8
tools/qfcc/include/def.h
View file

@ -37,7 +37,7 @@
/** \defgroup qfcc_def Def handling
\ingroup qfcc
*/
//@{
///@{
struct symbol_s;
struct expr_s;
@ -180,7 +180,7 @@ void free_def (def_t *def);
Temporary defs are bound to the current function (::current_func must
be valid). They are always allocated from the funciont's local defspace.
*/
//@{
///@{
/** Get a temporary def.
If the current function has a free temp def of the same size as \a size,
@ -207,7 +207,7 @@ def_t *temp_def (struct type_s *type);
\param temp The temp def to be recycled.
*/
void free_temp_def (def_t *temp);
//@}
///@}
/** Initialize a vm def from a qfcc def.
@ -306,6 +306,6 @@ int def_size (def_t *def) __attribute__((pure));
*/
int def_visit_all (def_t *def, int overlap,
int (*visit) (def_t *, void *), void *data);
//@}
///@}
#endif//__def_h

4
tools/qfcc/include/defspace.h
View file

@ -37,7 +37,7 @@
/** \defgroup qfcc_defspace Defspace handling
\ingroup qfcc
*/
//@{
///@{
typedef enum {
ds_backed, ///< data space is globally addressable (near/far/type) and
@ -145,6 +145,6 @@ void defspace_free_loc (defspace_t *space, int ofs, int size);
*/
int defspace_add_data (defspace_t *space, pr_type_t *data, int size);
//@}
///@}
#endif//__defspace_h

4
tools/qfcc/include/diagnostic.h
View file

@ -36,7 +36,7 @@
/** \defgroup qfcc_diagnostic Diagnostic Messages
\ingroup qfcc
*/
//@{
///@{
typedef void (*diagnostic_hook)(const char *message);
extern diagnostic_hook bug_hook;
@ -73,6 +73,6 @@ void _bug (struct expr_s *e, const char *file, int line, const char *fmt, ...)
__attribute__ ((format (printf, 4, 5)));
#define bug(e, fmt...) _bug(e, __FILE__, __LINE__, fmt)
//@}
///@}
#endif//__diagnostic_h

4
tools/qfcc/include/expr.h
View file

@ -36,7 +36,7 @@
/** \defgroup qfcc_expr Expressions
\ingroup qfcc
*/
//@{
///@{
/** Type of the exression node in an expression tree.
*/
@ -652,6 +652,6 @@ expr_t *sizeof_expr (expr_t *expr, struct type_s *type);
expr_t *fold_constants (expr_t *e);
//@}
///@}
#endif//__expr_h

4
tools/qfcc/include/flow.h
View file

@ -33,7 +33,7 @@
/** \defgroup qfcc_flow Flow graph analysis
\ingroup qfcc
*/
//@{
///@{
struct function_s;
struct sblock_s;
@ -120,6 +120,6 @@ void dump_dot_flow_live (void *g, const char *filename);
void dump_dot_flow_reaching (void *g, const char *filename);
void dump_dot_flow_statements (void *g, const char *filename);
//@}
///@}
#endif//flow_h

4
tools/qfcc/include/function.h
View file

@ -34,7 +34,7 @@
/** \defgroup qfcc_function Internal function structures.
\ingroup qfcc
*/
//@{
///@{
#include "QF/pr_comp.h"
#include "QF/pr_debug.h"
@ -147,6 +147,6 @@ void emit_function (function_t *f, struct expr_s *e);
int function_parms (function_t *f, byte *parm_size);
void clear_functions (void);
//@}
///@}
#endif//__function_h

21
tools/qfcc/include/obj_file.h
View file

@ -34,7 +34,7 @@
/** \defgroup qfcc_qfo Object file functions
\ingroup qfcc
*/
//@{
///@{
#include "QF/pr_comp.h"
#include "QF/pr_debug.h"
@ -106,12 +106,12 @@ typedef struct qfo_def_s {
string_t file; ///< source file name
pr_uint_t line; ///< source line number
} qfo_def_t;
//@}
///@}
/** \defgroup qfcc_qfo_QFOD QFOD flags
\ingroup qfcc_qfo
*/
//@{
///@{
/** The def has been initialized.
@ -168,11 +168,11 @@ typedef struct qfo_def_s {
\hideinitializer
*/
#define QFOD_PARAM (1u<<8)
//@}
///@}
/** \addtogroup qfcc_qfo
*/
//@{
///@{
/** Representation of a function in the object file.
*/
@ -286,13 +286,13 @@ enum {
qfo_num_spaces
};
//@}
///@}
/** \defgroup qfcc_qfo_data_access QFO Data Acess
\ingroup qfcc_qfo
Macros for accessing data in the QFO address space
*/
//@{
///@{
/** \internal
\param q pointer to ::qfo_t struct
@ -361,7 +361,6 @@ enum {
\param q pointer to ::qfo_t struct
\param s space index
\param s offset into object file string space
\return (char *)
\hideinitializer
@ -439,11 +438,11 @@ enum {
*/
#define QFO_STRUCT(q, s, t, o) (*QFO_POINTER (q, s, t, o))
//@}
///@}
/** \addtogroup qfcc_qfo
*/
//@{
///@{
struct pr_info_s;
@ -485,6 +484,6 @@ qfo_t *qfo_new (void);
*/
void qfo_delete (qfo_t *qfo);
//@}
///@}
#endif//__obj_file_h

2
tools/qfcc/include/obj_type.h
View file

@ -38,6 +38,4 @@
struct type_s;
struct def_s *qfo_encode_type (struct type_s *type);
//@}
#endif//__obj_type_h

4
tools/qfcc/include/pragma.h
View file

@ -33,10 +33,10 @@
/** \defgroup qfcc_pragma pragma handling
\ingroup qfcc
*/
//@{
///@{
void pragma (const char *id);
//@}
///@}
#endif//pragma_h

4
tools/qfcc/include/qfcc.h
View file

@ -39,7 +39,7 @@
/** \defgroup qfcc_general General functions
\ingroup qfcc
*/
//@{
///@{
typedef struct srcline_s srcline_t;
struct srcline_s {
@ -132,6 +132,6 @@ char *fix_backslash (char *path);
*/
#define RUP(x,a) (((x) + ((a) - 1)) & ~((a) - 1))
//@}
///@}
#endif//__qfcc_h

4
tools/qfcc/include/symtab.h
View file

@ -39,7 +39,7 @@ enum storage_class_e;
/** \defgroup qfcc_symtab Symbol Table Management
\ingroup qfcc
*/
//@{
///@{
typedef enum vis_e {
vis_public,
@ -235,6 +235,6 @@ symtab_t *symtab_flat_copy (symtab_t *symtab, symtab_t *parent);
symbol_t *make_symbol (const char *name, struct type_s *type,
struct defspace_s *space, enum storage_class_e storage);
//@}
///@}
#endif//__symtab_h

4
tools/qfcc/include/value.h
View file

@ -34,7 +34,7 @@
/** \defgroup qfcc_value Constant values.
\ingroup qfcc_expr
*/
//@{
///@{
struct ex_value_s;
struct type_s;
@ -63,6 +63,6 @@ int ReuseString (const char *str);
void clear_immediates (void);
//@}
///@}
#endif//__value_h

4
tools/qflight/include/entities.h
View file

@ -34,7 +34,7 @@
/** \defgroup qflight_entities Light entity data.
\ingroup qflight
*/
//@{
///@{
#define DEFAULTLIGHTLEVEL 300
#define DEFAULTFALLOFF 1.0f
@ -106,6 +106,6 @@ void GetVectorForKey (entity_t *ent, const char *key, vec3_t vec);
void LoadEntities (void);
void WriteEntitiesToString (void);
//@}
///@}
#endif// __entities_h

4
tools/qflight/include/light.h
View file

@ -37,7 +37,7 @@
/** \defgroup qflight_general General functions
\ingroup qflight
*/
//@{
///@{
#define ON_EPSILON 0.1
#define MAXLIGHTS 1024
@ -130,6 +130,6 @@ extern int num_novislights;
const char *get_tex_name (int texindex) __attribute__((pure));
//@}
///@}
#endif// __light_h

4
tools/qflight/include/noise.h
View file

@ -31,7 +31,7 @@
/** \defgroup qflight_noise Light noise functions.
\ingroup qflight
*/
//@{
///@{
float noise3d (vec3_t v, int num) __attribute__((pure));
float noiseXYZ (float x, float y, float z, int num) __attribute__((pure));
@ -39,4 +39,4 @@ float noise_scaled (vec3_t v, float s, int num) __attribute__((pure));
float noise_perlin (vec3_t v, float p, int num) __attribute__((pure));
void snap_vector (vec3_t v_old, vec3_t v_new, float scale);
//@}
///@}

4
tools/qflight/include/options.h
View file

@ -33,7 +33,7 @@
/** \defgroup qflight_options Light command line options.
\ingroup qflight
*/
//@{
///@{
typedef struct {
int verbosity; // 0=silent
@ -59,6 +59,6 @@ extern const char *this_program;
int DecodeArgs (int argc, char **argv);
void usage (int status) __attribute__((noreturn));
//@}
///@}
#endif//__options_h

4
tools/qflight/include/properties.h
View file

@ -33,7 +33,7 @@
/** \defgroup qflight_properties Lighting properties
\ingroup qflight
*/
//@{
///@{
struct plitem_s;
@ -199,6 +199,6 @@ void set_properties (entity_t *ent, struct plitem_s *dict);
*/
void LoadProperties (const char *filename);
//@}
///@}
#endif//__properties_h

4
tools/qflight/include/threads.h
View file

@ -32,7 +32,7 @@
/** \defgroup qflight_threads Light thread handling.
\ingroup qflight
*/
//@{
///@{
#if defined (HAVE_PTHREAD_H) && defined (HAVE_PTHREAD)
@ -66,6 +66,6 @@ typedef void *(threadfunc_t) (void *);
void InitThreads (void);
void RunThreadsOn (threadfunc_t func);
//@}
///@}
#endif// __threads_h