forked from pz4kybsvg/Conception
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
385 lines
14 KiB
385 lines
14 KiB
# Doxyfile 1.8.15
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = Drake
|
|
PROJECT_NUMBER =
|
|
PROJECT_BRIEF =
|
|
PROJECT_LOGO =
|
|
OUTPUT_DIRECTORY = "@OUTPUT_DIRECTORY@"
|
|
CREATE_SUBDIRS = NO
|
|
ALLOW_UNICODE_NAMES = NO
|
|
OUTPUT_LANGUAGE = English
|
|
OUTPUT_TEXT_DIRECTION = None
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF = "The $name class" \
|
|
"The $name widget" \
|
|
"The $name file" \
|
|
is \
|
|
provides \
|
|
specifies \
|
|
contains \
|
|
represents \
|
|
a \
|
|
an \
|
|
the
|
|
ALWAYS_DETAILED_SEC = NO
|
|
INLINE_INHERITED_MEMB = NO
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = "@INPUT_ROOT@"
|
|
STRIP_FROM_INC_PATH = "@INPUT_ROOT@"
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = YES
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 2
|
|
ALIASES = "default=@n @a Default: " \
|
|
"concept{1}=@ingroup \1\n@par Implemented concepts:\n@ref \1" \
|
|
"tparam_default_scalar=@tparam T The scalar type, which must be one of the @ref default_scalars \"default scalars\". " \
|
|
"tparam_nonsymbolic_scalar=@tparam T The scalar type, which must be one of the @ref default_scalars \"default nonsymbolic scalars\". " \
|
|
"tparam_double_only=@tparam T The scalar type, which must be `double`. " \
|
|
"experimental=@warning This feature is considered to be **experimental** and may change or be removed at any time, without any deprecation notice ahead of time. " \
|
|
"pydrake_mkdoc_identifier{1}= " \
|
|
"exclude_from_pydrake_mkdoc{1}= "
|
|
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
|
|
TOC_INCLUDE_HEADINGS = 0
|
|
AUTOLINK_SUPPORT = YES
|
|
BUILTIN_STL_SUPPORT = YES
|
|
CPP_CLI_SUPPORT = NO
|
|
SIP_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = YES
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
GROUP_NESTED_COMPOUNDS = NO
|
|
SUBGROUPING = YES
|
|
INLINE_GROUPED_CLASSES = NO
|
|
INLINE_SIMPLE_STRUCTS = NO
|
|
TYPEDEF_HIDES_STRUCT = YES
|
|
LOOKUP_CACHE_SIZE = 0
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = NO
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = NO
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
EXTRACT_ANON_NSPACES = NO
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
HIDE_UNDOC_CLASSES = NO
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = NO
|
|
INTERNAL_DOCS = NO
|
|
CASE_SENSE_NAMES = NO
|
|
HIDE_SCOPE_NAMES = YES
|
|
HIDE_COMPOUND_REFERENCE= NO
|
|
SHOW_INCLUDE_FILES = YES
|
|
SHOW_GROUPED_MEMB_INC = NO
|
|
FORCE_LOCAL_INCLUDES = NO
|
|
INLINE_INFO = NO
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = NO
|
|
SORT_MEMBERS_CTORS_1ST = NO
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
STRICT_PROTO_MATCHING = NO
|
|
GENERATE_TODOLIST = NO
|
|
GENERATE_TESTLIST = NO
|
|
GENERATE_BUGLIST = NO
|
|
GENERATE_DEPRECATEDLIST= YES
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 30
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE = "@INPUT_ROOT@/drake/doc/doxygen_cxx/DoxygenLayout.xml"
|
|
CITE_BIB_FILES =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
QUIET = YES
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = YES
|
|
WARN_AS_ERROR = NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE = doxygen.log
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
INPUT = "@INPUT_ROOT@"
|
|
INPUT_ENCODING = UTF-8
|
|
FILE_PATTERNS = *.h \
|
|
*.hh \
|
|
*.hxx \
|
|
*.hpp \
|
|
*.h++
|
|
RECURSIVE = YES
|
|
EXCLUDE =
|
|
EXCLUDE_SYMLINKS = NO
|
|
EXCLUDE_PATTERNS = "@INPUT_ROOT@/*/dev/*" \
|
|
"@INPUT_ROOT@/*/test/*" \
|
|
"@INPUT_ROOT@/*/MG/*"
|
|
EXCLUDE_SYMBOLS = "*::internal" \
|
|
"pybind11"
|
|
# Don't document our (obvious) Eigen overloads like "isinf", etc.
|
|
EXCLUDE_SYMBOLS += "Eigen"
|
|
EXAMPLE_PATH =
|
|
EXAMPLE_PATTERNS =
|
|
EXAMPLE_RECURSIVE = NO
|
|
IMAGE_PATH = "@INPUT_ROOT@/drake"
|
|
INPUT_FILTER = "@INPUT_ROOT@/drake/doc/doxygen_cxx/system_doxygen.py"
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = NO
|
|
FILTER_SOURCE_PATTERNS =
|
|
USE_MDFILE_AS_MAINPAGE =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
SOURCE_BROWSER = NO
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = NO
|
|
REFERENCED_BY_RELATION = NO
|
|
REFERENCES_RELATION = NO
|
|
REFERENCES_LINK_SOURCE = YES
|
|
SOURCE_TOOLTIPS = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
ALPHABETICAL_INDEX = YES
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
IGNORE_PREFIX =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = "."
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER = "@INPUT_ROOT@/drake/doc/doxygen_cxx/header.html"
|
|
HTML_FOOTER = "@INPUT_ROOT@/drake/doc/doxygen_cxx/footer.html"
|
|
HTML_STYLESHEET =
|
|
HTML_EXTRA_STYLESHEET = "@INPUT_ROOT@/drake/doc/doxygen_cxx/doxygen_extra.css"
|
|
HTML_EXTRA_FILES =
|
|
HTML_COLORSTYLE_HUE = 220
|
|
HTML_COLORSTYLE_SAT = 100
|
|
HTML_COLORSTYLE_GAMMA = 80
|
|
HTML_TIMESTAMP = NO
|
|
HTML_DYNAMIC_MENUS = YES
|
|
HTML_DYNAMIC_SECTIONS = NO
|
|
HTML_INDEX_NUM_ENTRIES = 100
|
|
GENERATE_DOCSET = NO
|
|
DOCSET_FEEDNAME =
|
|
DOCSET_BUNDLE_ID =
|
|
DOCSET_PUBLISHER_ID =
|
|
DOCSET_PUBLISHER_NAME =
|
|
GENERATE_HTMLHELP = NO
|
|
CHM_FILE =
|
|
HHC_LOCATION =
|
|
GENERATE_CHI = NO
|
|
CHM_INDEX_ENCODING =
|
|
BINARY_TOC = NO
|
|
TOC_EXPAND = NO
|
|
GENERATE_QHP = NO
|
|
QCH_FILE =
|
|
QHP_NAMESPACE =
|
|
QHP_VIRTUAL_FOLDER = doc
|
|
QHP_CUST_FILTER_NAME =
|
|
QHP_CUST_FILTER_ATTRS =
|
|
QHP_SECT_FILTER_ATTRS =
|
|
QHG_LOCATION =
|
|
GENERATE_ECLIPSEHELP = NO
|
|
ECLIPSE_DOC_ID =
|
|
DISABLE_INDEX = YES # Disables the header tabs (not the index) 🤦.
|
|
GENERATE_TREEVIEW = YES
|
|
ENUM_VALUES_PER_LINE = 4
|
|
TREEVIEW_WIDTH = 250
|
|
EXT_LINKS_IN_WINDOW = NO
|
|
FORMULA_FONTSIZE = 10
|
|
FORMULA_TRANSPARENT = YES
|
|
USE_MATHJAX = YES
|
|
MATHJAX_FORMAT = HTML-CSS
|
|
MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5
|
|
MATHJAX_EXTENSIONS =
|
|
MATHJAX_CODEFILE =
|
|
SEARCHENGINE = YES
|
|
SERVER_BASED_SEARCH = NO
|
|
EXTERNAL_SEARCH = NO
|
|
SEARCHENGINE_URL =
|
|
SEARCHDATA_FILE = searchdata.xml
|
|
EXTERNAL_SEARCH_ID =
|
|
EXTRA_SEARCH_MAPPINGS =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = NO
|
|
LATEX_OUTPUT = latex
|
|
LATEX_CMD_NAME = latex
|
|
MAKEINDEX_CMD_NAME = makeindex
|
|
LATEX_MAKEINDEX_CMD = \makeindex
|
|
COMPACT_LATEX = NO
|
|
PAPER_TYPE = letter
|
|
EXTRA_PACKAGES = amsmath
|
|
LATEX_HEADER =
|
|
LATEX_FOOTER =
|
|
LATEX_EXTRA_STYLESHEET =
|
|
LATEX_EXTRA_FILES =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = NO
|
|
LATEX_HIDE_INDICES = NO
|
|
LATEX_SOURCE_CODE = NO
|
|
LATEX_BIB_STYLE = plain
|
|
LATEX_TIMESTAMP = YES
|
|
LATEX_EMOJI_DIRECTORY =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the RTF output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_RTF = NO
|
|
RTF_OUTPUT = rtf
|
|
COMPACT_RTF = NO
|
|
RTF_HYPERLINKS = NO
|
|
RTF_STYLESHEET_FILE =
|
|
RTF_EXTENSIONS_FILE =
|
|
RTF_SOURCE_CODE = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the man page output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_MAN = NO
|
|
MAN_OUTPUT = man
|
|
MAN_EXTENSION = .3
|
|
MAN_SUBDIR =
|
|
MAN_LINKS = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the XML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_XML = NO
|
|
XML_OUTPUT = xml
|
|
XML_PROGRAMLISTING = YES
|
|
XML_NS_MEMB_FILE_SCOPE = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the DOCBOOK output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_DOCBOOK = NO
|
|
DOCBOOK_OUTPUT = docbook
|
|
DOCBOOK_PROGRAMLISTING = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options for the AutoGen Definitions output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the Perl module output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_PERLMOD = NO
|
|
PERLMOD_LATEX = NO
|
|
PERLMOD_PRETTY = YES
|
|
PERLMOD_MAKEVAR_PREFIX =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the preprocessor
|
|
#---------------------------------------------------------------------------
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = YES
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH =
|
|
INCLUDE_FILE_PATTERNS =
|
|
PREDEFINED = DRAKE_DOXYGEN_CXX=1 \
|
|
HAVE_SPDLOG=1
|
|
# =============================================================================
|
|
# N.B. The spelling of the macro names between common/drake_copyable.h and this
|
|
# file must be kept in sync!
|
|
# =============================================================================
|
|
# The following macros are carefully crafted to retain good markup when they
|
|
# pass through Doxygen's preprocessor.
|
|
PREDEFINED += DRAKE_NO_COPY_NO_MOVE_NO_ASSIGN(X):=" \
|
|
/** \name Does not allow copy, move, or assignment */ \
|
|
/** \{ */ \
|
|
X(const X&) = delete; \
|
|
X& operator=(const X&) = delete; \
|
|
X(X&&) = delete; \
|
|
X& operator=(X&&) = delete; \
|
|
/** \} */"
|
|
PREDEFINED += DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN(X):=" \
|
|
/** \name Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable */ \
|
|
/** \{ */ \
|
|
X(const X&) = default; \
|
|
X& operator=(const X&) = default; \
|
|
X(X&&) = default; \
|
|
X& operator=(X&&) = default; \
|
|
/** \} */"
|
|
PREDEFINED += DRAKE_DECLARE_COPY_AND_MOVE_AND_ASSIGN(X):=" \
|
|
/** \name Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable */ \
|
|
/** \{ */ \
|
|
X(const X&) = default; \
|
|
X& operator=(const X&) = default; \
|
|
X(X&&) = default; \
|
|
X& operator=(X&&) = default; \
|
|
/** \} */"
|
|
PREDEFINED += "DRAKE_DEPRECATED(removal_date,message):= \
|
|
/** (Deprecated.) \deprecated message <br> \
|
|
This will be removed from Drake on or after removal_date. */ \
|
|
"
|
|
# =============================================================================
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE =
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
CLASS_DIAGRAMS = NO
|
|
DIA_PATH =
|
|
HIDE_UNDOC_RELATIONS = NO
|
|
HAVE_DOT = @DOXYGEN_DOT_FOUND@
|
|
DOT_NUM_THREADS = 0
|
|
DOT_FONTNAME = Helvetica
|
|
DOT_FONTSIZE = 10
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = NO
|
|
COLLABORATION_GRAPH = NO
|
|
GROUP_GRAPHS = NO
|
|
UML_LOOK = NO
|
|
UML_LIMIT_NUM_FIELDS = 10
|
|
TEMPLATE_RELATIONS = NO
|
|
INCLUDE_GRAPH = YES
|
|
INCLUDED_BY_GRAPH = YES
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = YES
|
|
DIRECTORY_GRAPH = YES
|
|
DOT_IMAGE_FORMAT = svg
|
|
INTERACTIVE_SVG = YES
|
|
DOT_PATH = "@DOXYGEN_DOT_EXECUTABLE@"
|
|
DOTFILE_DIRS = "@INPUT_ROOT@/drake"
|
|
MSCFILE_DIRS =
|
|
DIAFILE_DIRS =
|
|
PLANTUML_JAR_PATH =
|
|
PLANTUML_CFG_FILE =
|
|
PLANTUML_INCLUDE_PATH =
|
|
DOT_GRAPH_MAX_NODES = 100
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
|
DOT_TRANSPARENT = NO
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|