mirror of https://github.com/CGAL/cgal
835 lines
47 KiB
Plaintext
835 lines
47 KiB
Plaintext
# Doxyfile 1.10.0
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
# doxygen (www.doxygen.org) for a project.
|
|
#
|
|
# Only the settings that are not the default ones are kept in this file
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
|
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
|
# double-quotes, unless you are using Doxywizard) that should identify the
|
|
# project for which the documentation is generated. This name is used in the
|
|
# title of most generated pages and in a few other places.
|
|
# The default value is: My Project.
|
|
|
|
PROJECT_NAME =
|
|
|
|
# This tag implements a quasi-intelligent brief description abbreviator that is
|
|
# used to form the text in various listings. Each string in this list, if found
|
|
# as the leading text of the brief description, will be stripped from the text
|
|
# and the result, after processing the whole list, is used as the annotated
|
|
# text. Otherwise, the brief description is used as-is. If left blank, the
|
|
# following values are used ($name is automatically replaced with the name of
|
|
# the entity):The $name class, The $name widget, The $name file, is, provides,
|
|
# specifies, contains, represents, a, an and the.
|
|
|
|
ABBREVIATE_BRIEF =
|
|
|
|
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
|
|
# first line (until the first dot) of a Javadoc-style comment as the brief
|
|
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
|
|
# style comments (thus requiring an explicit @brief command for a brief
|
|
# description.)
|
|
# The default value is: NO.
|
|
|
|
JAVADOC_AUTOBRIEF = YES
|
|
|
|
# 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
|
|
# requiring an explicit \brief command for a brief description.)
|
|
# The default value is: NO.
|
|
|
|
QT_AUTOBRIEF = YES
|
|
|
|
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
|
|
# documentation from any documented member that it re-implements.
|
|
# The default value is: YES.
|
|
|
|
INHERIT_DOCS = NO
|
|
|
|
# This tag can be used to specify a number of aliases that act as commands in
|
|
# the documentation. An alias has the form:
|
|
# name=value
|
|
# For example adding
|
|
# "sideeffect=@par Side Effects:^^"
|
|
# 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:". Note that you cannot put \n's in the value part of an alias
|
|
# to insert 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 = "cgal=%CGAL" \
|
|
"protocgal=C++gal" \
|
|
"plageo=Plageo" \
|
|
"stl=STL" \
|
|
"gmp=GMP" \
|
|
"gmpxx=GMPXX" \
|
|
"iso=ISO" \
|
|
"lisp=Lisp" \
|
|
"ieee=IEEE" \
|
|
"ascii=ASCII" \
|
|
"exacus=Exacus" \
|
|
"mpir=MPIR" \
|
|
"mpfr=MPFR" \
|
|
"leda=LEDA" \
|
|
"gcc=GCC" \
|
|
"dcel=DCEL" \
|
|
"bgl=BGL" \
|
|
"boost=Boost" \
|
|
"gnu=GNU" \
|
|
"ms=MS" \
|
|
"qt=Qt" \
|
|
"qt6=Qt6" \
|
|
"eigen=Eigen" \
|
|
"opengr=OpenGR" \
|
|
"libpointmatcher=libpointmatcher" \
|
|
"core=Core" \
|
|
"mpfi=MPFI" \
|
|
"ntl=NTL" \
|
|
"pdb=PDB" \
|
|
"esbtl=ESBTL" \
|
|
"tbb=TBB" \
|
|
"laslib=LASlib" \
|
|
"opencv=OpenCV" \
|
|
"tensorflow=TensorFlow" \
|
|
"metis=METIS" \
|
|
"zlib=zlib" \
|
|
"ceres=Ceres" \
|
|
"glpk=GLPK" \
|
|
"scip=SCIP" \
|
|
"osqp=OSQP" \
|
|
"rs=RS" \
|
|
"rs3=RS3" \
|
|
"unix=Unix" \
|
|
"api=API" \
|
|
"vtk=VTK" \
|
|
"visualstudio=Visual Studio" \
|
|
"taucs=TAUCS" \
|
|
"lapack=LAPACK" \
|
|
"blas=BLAS" \
|
|
"cpp=C++" \
|
|
"cpp11=C++11" \
|
|
"CC=C++" \
|
|
"cgalExample{1}=<br><b>File</b> \ref \1 \include \1" \
|
|
"cgalFigureAnchor{1}=\anchor fig__\1" \
|
|
"cgalFigureRef{1}=\ref fig__\1" \
|
|
"cgalFigureBegin{2}=\anchor fig__\1 ^^ \image html \2 ^^ \image latex \2 \"\" width=15cm ^^ \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{3}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=7.5cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=7.5cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{4}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=5cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=5cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=5cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{5}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=3.75cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=3.75cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=3.75cm ^^ </TD> <TD> \image html \5 ^^ \image latex \5 \"\" width=3.75cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{6}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=3cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=3cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=3cm ^^ </TD> <TD> \image html \5 ^^ \image latex \5 \"\" width=3cm ^^ </TD> <TD> \image html \6 ^^ \image latex \6 \"\" width=3cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{7}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=2.5cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=2.5cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=2.5cm ^^ </TD> <TD> \image html \5 ^^ \image latex \5 \"\" width=2.5cm ^^ </TD> <TD> \image html \6 ^^ \image latex \6 \"\" width=2.5cm ^^ </TD> <TD> \image html \7 ^^ \image latex \7 \"\" width=2.5cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{8}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=2.1cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=2.1cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=2.1cm ^^ </TD> <TD> \image html \5 ^^ \image latex \5 \"\" width=2.1cm ^^ </TD> <TD> \image html \6 ^^ \image latex \6 \"\" width=2.1cm ^^ </TD> <TD> \image html \7 ^^ \image latex \7 \"\" width=2.1cm ^^ </TD> <TD> \image html \8 ^^ \image latex \8 \"\" width=2.1cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{9}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=1.9cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=1.9cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=1.9cm ^^ </TD> <TD> \image html \5 ^^ \image latex \5 \"\" width=1.9cm ^^ </TD> <TD> \image html \6 ^^ \image latex \6 \"\" width=1.9cm ^^ </TD> <TD> \image html \7 ^^ \image latex \7 \"\" width=1.9cm ^^ </TD> <TD> \image html \8 ^^ \image latex \8 \"\" width=1.9cm ^^ </TD> <TD> \image html \9 ^^ \image latex \9 \"\" width=1.9cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureBegin{10}=\anchor fig__\1 ^^ <CENTER> <TABLE border=0> <TR> <TD> \image html \2 ^^ \image latex \2 \"\" width=1.6cm ^^ </TD> <TD> \image html \3 ^^ \image latex \3 \"\" width=1.6cm ^^ </TD> <TD> \image html \4 ^^ \image latex \4 \"\" width=1.6cm ^^ </TD> <TD> \image html \5 ^^ \image latex \5 \"\" width=1.6cm ^^ </TD> <TD> \image html \6 ^^ \image latex \6 \"\" width=1.6cm ^^ </TD> <TD> \image html \7 ^^ \image latex \7 \"\" width=1.6cm ^^ </TD> <TD> \image html \8 ^^ \image latex \8 \"\" width=1.6cm ^^ </TD> <TD> \image html \9 ^^ \image latex \9 \"\" width=1.6cm ^^ </TD> <TD> \image html \10 ^^ \image latex \10 \"\" width=1.6cm ^^ </TD> </TR> </TABLE> </CENTER> \htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly ^^ \ref fig__\1" \
|
|
"cgalFigureEnd=\htmlonly[block] </div> \endhtmlonly <br>" \
|
|
"cgalFigureCaptionBegin{1}=\htmlonly[block] <div class=\"cgal_figure_caption\"> \endhtmlonly \ref fig__\1" \
|
|
"cgalFigureCaptionEnd=\htmlonly[block] </div> \endhtmlonly <br>" \
|
|
"cgalConcept=\details <div id=\"CGALConcept\"></div>^^ \brief" \
|
|
"cgalConceptNamespace=\details <div id=\"CGALConceptNS\"></div>^^ \brief" \
|
|
"cgalRefines=Refines" \
|
|
"cgalRefines{1}=<dl><dt>@cgalRefines</dt><dd>@c \1</dd></dl>" \
|
|
"cgalRefines{2}=<dl><dt>@cgalRefines</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd></dl>" \
|
|
"cgalRefines{3}=<dl><dt>@cgalRefines</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd></dl>" \
|
|
"cgalRefines{4}=<dl><dt>@cgalRefines</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd><dt></dt><dd>@c \4</dd></dl>" \
|
|
"cgalRefines{5}=<dl><dt>@cgalRefines</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd><dt></dt><dd>@c \4</dd><dt></dt><dd>@c \5</dd></dl>" \
|
|
"cgalRefinesBare{1}=<dl><dt>@cgalRefines</dt><dd>\1</dd></dl>" \
|
|
"cgalRefinesBare{2}=<dl><dt>@cgalRefines</dt><dd>@c \1</dd><dt></dt><dd>\2</dd></dl>" \
|
|
"cgalModelsHeader=Is model of" \
|
|
"cgalModels{1}=<dl><dt>@cgalModelsHeader</dt><dd>@c \1</dd></dl>" \
|
|
"cgalModels{2}=<dl><dt>@cgalModelsHeader</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd></dl>" \
|
|
"cgalModels{3}=<dl><dt>@cgalModelsHeader</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd></dl>" \
|
|
"cgalModels{4}=<dl><dt>@cgalModelsHeader</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd><dt></dt><dd>@c \4</dd></dl>" \
|
|
"cgalModels{5}=<dl><dt>@cgalModelsHeader</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd><dt></dt><dd>@c \4</dd><dt></dt><dd>@c \5</dd></dl>" \
|
|
"cgalModels{6}=<dl><dt>@cgalModelsHeader</dt><dd>@c \1</dd><dt></dt><dd>@c \2</dd><dt></dt><dd>@c \3</dd><dt></dt><dd>@c \4</dd><dt></dt><dd>@c \5</dd><dt></dt><dd>@c \6</dd></dl>" \
|
|
"cgalModelsBareBegin=<dl><dt>@cgalModelsHeader</dt><dd></dd>" \
|
|
"cgalModelsBareEnd=</dl>" \
|
|
"cgalModelsBare{1}=<dt></dt><dd>\1</dd>" \
|
|
"cgalGeneralizes=\xrefitem generalizes \"Generalizes\" \"Generalization Relationships\"" \
|
|
"cgalHasModelsHeader=Has models" \
|
|
"cgalHasModelsBegin=<dl><dt>@cgalHasModelsHeader</dt><dd></dd>" \
|
|
"cgalHasModels{1}=<dt></dt><dd>`\1`</dd>" \
|
|
"cgalHasModelsBare{1}=<dt></dt><dd>\1</dd>" \
|
|
"cgalHasModelsEnd=</dl>" \
|
|
"cgalDebugBegin=\htmlonly[block] <div class=\"CGALDebug\"> <div>Debugging Support</div> \endhtmlonly ^^" \
|
|
"cgalDebugEnd=\htmlonly[block] </div> \endhtmlonly" \
|
|
"cgalDebugFunction=This is a function for debugging purpose." \
|
|
"cgalAdvancedBegin=^^ \htmlonly[block] <div class=\"CGALAdvanced\"> <div>Advanced</div> \endhtmlonly ^^" \
|
|
"cgalAdvancedEnd=\noop ^^ \htmlonly[block] </div> \endhtmlonly" \
|
|
"cgalAdvancedFunction=This is an advanced function." \
|
|
"cgalAdvancedClass=This is an advanced class." \
|
|
"cgalAdvancedType=This is an advanced type." \
|
|
"cgalAdvancedConcept=This is an advanced concept." \
|
|
"cgalRequiresCPP11=\warning This function requires a C++11 compiler." \
|
|
"cgalPkgPicture{1}=<div class=\"PkgImage\"> ^^ \image html \1 ^^</div>" \
|
|
"cgalPkgSummaryBegin=<div class=\"PkgSummary\">" \
|
|
"cgalPkgSummaryEnd=</div>" \
|
|
"cgalPkgShortInfoBegin=<div class=\"PkgShortInfo\">" \
|
|
"cgalPkgShortInfoEnd=</div>" \
|
|
"cgalPkgAuthor{1}=<div class=\"PkgAuthors\">\1</div>" \
|
|
"cgalPkgAuthors{1}=\cgalPkgAuthor{\1}" \
|
|
"cgalPkgDesc{1}=<div class=\"PkgDescription\">\1</div>" \
|
|
"cgalPkgSince{1}=<B>Introduced in:</B> \cgal \1<BR>" \
|
|
"cgalPkgDependsOn{1}=<B>Depends on:</B> \1 <BR>" \
|
|
"cgalPkgLicense{1}=<B>License:</B> \1 <BR>" \
|
|
"cgalPkgDemo{2}=<B>Windows Demo:</B> <a href=\"https://www.cgal.org/demo/${CGAL_CREATED_VERSION_NUM}/\2\">\1</a><BR>" \
|
|
"cgalPkgDemo{4}=<B>Windows Demos:</B> <a href=\"https://www.cgal.org/demo/${CGAL_CREATED_VERSION_NUM}/\2\">\1</a>, <a href=\"https://www.cgal.org/demo/${CGAL_CREATED_VERSION_NUM}/\4\">\3</a><BR>" \
|
|
"cgalPkgDemo{6}=<B>Windows Demos:</B> <a href=\"https://www.cgal.org/demo/${CGAL_CREATED_VERSION_NUM}/\2\">\1</a>, <a href=\"https://www.cgal.org/demo/${CGAL_CREATED_VERSION_NUM}/\4\">\3</a>, <a href=\"https://www.cgal.org/demo/${CGAL_CREATED_VERSION_NUM}/\6\">\5</a><BR>" \
|
|
"cgalPkgDescriptionEnd=" \
|
|
"cgalModifBegin=\htmlonly <div class=\"CGALModification\"> \endhtmlonly \xrefitem Modification \"Modifications\" \"MODIFICATIONS\"" \
|
|
"cgalModifEnd=\htmlonly </div> \endhtmlonly \latexonly END MODIFICATIONS \endlatexonly" \
|
|
"cgalPkgBib{1}=<B>BibTeX:</B> <a href=\"../Manual/how_to_cite_cgal.html#\1-${CGAL_RELEASE_YEAR_ID}\">\1-${CGAL_RELEASE_YEAR_ID}</a><BR>" \
|
|
"cgalFootnote{1}=<span class=\"footnote\">\1</span>" \
|
|
"cgalFootnoteCode{1}=<tt style='display:inline'>\1</tt>" \
|
|
"cgalAutoToc=\htmlonly[block] <div id=\"autotoc\" class=\"toc\"></div> \endhtmlonly" \
|
|
"cgalTagTrue=\link CGAL::Tag_true `CGAL::Tag_true`\endlink" \
|
|
"cgalTagFalse=\link CGAL::Tag_false `CGAL::Tag_false`\endlink" \
|
|
"cgalHeading{1}= <B>\1</B><BR>" \
|
|
"cgalClassifedRefPages=\htmlonly[block] <h2 class=\"groupheader\">Classified Reference Pages</h2> \endhtmlonly" \
|
|
"cgalCRPSection{1}=<h2>\1</h2>" \
|
|
"cgalCRPSubsection{1}=<h3>\1</h3>" \
|
|
"cgalCite{1}=<!-- -->\cite \1" \
|
|
"cgalPackageSection{2}=\htmlonly[block] <div style=\"background-color: #EEEDF2;\">\endhtmlonly \section \1 \2 ^^ \htmlonly[block] </div>\endhtmlonly" \
|
|
"cgalNamedParamsBegin=<dl class=\"params\"><dt>Optional Named Parameters</dt><dd> <table class=\"params\">" \
|
|
"cgalNamedParamsBegin{1}=<dl class=\"params\"><dt>\1</dt><dd> <table class=\"params\">" \
|
|
"cgalNamedParamsEnd=</table> </dd> </dl>" \
|
|
"cgalParamNBegin{1}=<tr><td class> \htmlonly[block] <button class=\"collapsible\">\endhtmlonly <b>\1</b> \htmlonly[block]</button> <div class=\"content\">\endhtmlonly<ul>" \
|
|
"cgalParamDescription{1}=<li>\1</li>" \
|
|
"cgalParamType{1}=<li><b>Type: </b>\1</li>" \
|
|
"cgalParamDefault{1}=<li><b>%Default: </b>\1</li>" \
|
|
"cgalParamExtra{1}=<li><b>Extra: </b>\1</li>" \
|
|
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
|
|
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
|
|
"cgalParamSectionEnd=\cgalParamNEnd" \
|
|
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
|
|
"cgalBigO{1}=\f$O(\1)\f$" \
|
|
"cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
|
|
"cgalInclude{1}=`#include<\1>`" \
|
|
"cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"
|
|
|
|
# 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,
|
|
# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
|
|
# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
|
|
# FortranFree, unknown formatted Fortran: Fortran. In the latter case the parser
|
|
# tries to guess whether the code is fixed or free formatted code, this is the
|
|
# default for Fortran type files). 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.
|
|
#
|
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
|
# the files are not read by doxygen. When specifying no_extension you should add
|
|
# * to the FILE_PATTERNS.
|
|
#
|
|
# Note see also the list of default file extension mappings.
|
|
|
|
EXTENSION_MAPPING = txt=C++
|
|
|
|
# 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 = 0
|
|
|
|
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
|
# to include (a tag file for) the STL sources as input, then you should set this
|
|
# tag to YES in order to let doxygen match functions declarations and
|
|
# definitions whose arguments contain STL classes (e.g. func(std::string);
|
|
# versus func(std::string) {}). This also make the inheritance and collaboration
|
|
# diagrams that involve STL classes more complete and accurate.
|
|
# The default value is: NO.
|
|
|
|
BUILTIN_STL_SUPPORT = YES
|
|
|
|
# For Microsoft's IDL there are propget and propput attributes to indicate
|
|
# getter and setter methods for a property. Setting this option to YES will make
|
|
# doxygen to replace the get and set methods by a property in the documentation.
|
|
# This will only work if the methods are indeed getting or setting a simple
|
|
# type. If this is not the case, or you want to show the methods anyway, you
|
|
# should set this option to NO.
|
|
# The default value is: YES.
|
|
|
|
IDL_PROPERTY_SUPPORT = NO
|
|
|
|
# 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
|
|
# subgrouping. Alternatively, this can be done per class using the
|
|
# \nosubgrouping command.
|
|
# The default value is: YES.
|
|
|
|
SUBGROUPING = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
|
|
# documentation are documented, even if no documentation was available. Private
|
|
# class members and static file members will be hidden unless the
|
|
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
|
|
# Note: This will also disable the warnings about undocumented members that are
|
|
# normally produced when WARNINGS is set to YES.
|
|
# The default value is: NO.
|
|
|
|
EXTRACT_ALL = YES
|
|
|
|
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
|
|
# included in the documentation.
|
|
# The default value is: NO.
|
|
|
|
EXTRACT_STATIC = YES
|
|
|
|
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
|
|
# grouped member an include statement to the documentation, telling the reader
|
|
# which file to include in order to use the member.
|
|
# The default value is: NO.
|
|
|
|
SHOW_GROUPED_MEMB_INC = YES
|
|
|
|
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
|
|
# documentation for inline members.
|
|
# The default value is: YES.
|
|
|
|
INLINE_INFO = NO
|
|
|
|
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
|
|
# fully-qualified names, including namespaces. If set to NO, the class list will
|
|
# be sorted only by class name, not including the namespace part.
|
|
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
|
# Note: This option applies only to the class list, not to the alphabetical
|
|
# list.
|
|
# The default value is: NO.
|
|
|
|
SORT_BY_SCOPE_NAME = YES
|
|
|
|
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
|
|
# the bottom of the documentation of classes and structs. If set to YES, the
|
|
# list will mention the files that were used to generate the documentation.
|
|
# The default value is: YES.
|
|
|
|
SHOW_USED_FILES = NO
|
|
|
|
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
|
|
# will remove the Files entry from the Quick Index and from the Folder Tree View
|
|
# (if specified).
|
|
# The default value is: YES.
|
|
|
|
SHOW_FILES = NO
|
|
|
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
|
# by doxygen. The layout file controls the global structure of the generated
|
|
# output files in an output format independent way. To create the layout file
|
|
# that represents doxygen's defaults, run doxygen with the -l option. You can
|
|
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
|
|
# will be used as the name of the layout file. See also section "Changing the
|
|
# layout of pages" for information.
|
|
#
|
|
# Note that if you run doxygen from a directory containing a file called
|
|
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
|
# tag is left empty.
|
|
|
|
LAYOUT_FILE = ${CGAL_DOC_RESOURCE_DIR}/DoxygenLayoutPackage.xml
|
|
|
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
|
|
# the reference definitions. This must be a list of .bib files. The .bib
|
|
# extension is automatically appended if omitted. This requires the bibtex tool
|
|
# 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.
|
|
|
|
CITE_BIB_FILES = ${CGAL_DOC_BIBLIO_DIR}/cgal_manual.bib \
|
|
${CGAL_DOC_BIBLIO_DIR}/geom.bib
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
|
|
# The QUIET tag can be used to turn on/off the messages that are generated to
|
|
# standard output by doxygen. If QUIET is set to YES this implies that the
|
|
# messages are off.
|
|
# The default value is: NO.
|
|
|
|
QUIET = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
|
|
# 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.
|
|
#
|
|
# 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.
|
|
#
|
|
# Note the list of default checked file patterns might differ from the list of
|
|
# default file extension mappings.
|
|
#
|
|
# 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++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
|
|
# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
|
|
# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
|
|
# *.vhdl, *.ucf, *.qsf and *.ice.
|
|
|
|
FILE_PATTERNS = *.cpp \
|
|
*.txt \
|
|
*.md \
|
|
*.h \
|
|
*.hpp
|
|
|
|
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
|
# be searched for input files as well.
|
|
# The default value is: NO.
|
|
|
|
RECURSIVE = YES
|
|
|
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
|
# (namespaces, classes, functions, etc.) that should be excluded from the
|
|
# output. The symbol name can be a fully qualified name, a word, or if the
|
|
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
|
# ANamespace::AClass, ANamespace::*Test
|
|
|
|
EXCLUDE_SYMBOLS = Tr \
|
|
Vb \
|
|
Cb \
|
|
Fb \
|
|
K \
|
|
Traits \
|
|
internal
|
|
|
|
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
|
|
# *.h) to filter out the source-files in the directories. If left blank all
|
|
# files are included.
|
|
|
|
EXAMPLE_PATTERNS = *.cpp \
|
|
*.h
|
|
|
|
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
|
# searched for input files to be used with the \include or \dontinclude commands
|
|
# irrespective of the value of the RECURSIVE tag.
|
|
# The default value is: NO.
|
|
|
|
EXAMPLE_RECURSIVE = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
|
|
# verbatim copy of the header file for each class for which an include is
|
|
# specified. Set to NO to disable this.
|
|
# See also: Section \class.
|
|
# The default value is: YES.
|
|
|
|
VERBATIM_HEADERS = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
|
|
# compounds will be generated. Enable this if the project contains a lot of
|
|
# classes, structs, unions or interfaces.
|
|
# The default value is: YES.
|
|
|
|
ALPHABETICAL_INDEX = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
|
|
#
|
|
# To get valid HTML the header file that includes any scripts and style sheets
|
|
# that doxygen needs, which is dependent on the configuration options used (e.g.
|
|
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
|
|
# default header using
|
|
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
|
|
# YourConfigFile
|
|
# and then modify the file new_header.html. See also section "Doxygen usage"
|
|
# for information on how to generate the default header that doxygen normally
|
|
# uses.
|
|
# Note: The header is subject to change so you typically have to regenerate the
|
|
# default header when upgrading to a newer version of doxygen. For a description
|
|
# of the possible markers and block names see the documentation.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
HTML_HEADER = ${CGAL_DOC_HEADER_PACKAGE}
|
|
|
|
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
|
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
|
# footer. See HTML_HEADER for more information on how to generate a default
|
|
# footer and what special commands can be used inside the footer. See also
|
|
# section "Doxygen usage" for information on how to generate the default footer
|
|
# that doxygen normally uses.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
HTML_FOOTER = ${CGAL_DOC_RESOURCE_DIR}/footer.html
|
|
|
|
# Doxygen stores a couple of settings persistently in the browser (via e.g.
|
|
# cookies). By default these settings apply to all HTML pages generated by
|
|
# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
|
|
# the settings under a project specific key, such that the user preferences will
|
|
# be stored separately.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
HTML_PROJECT_COOKIE = CGAL
|
|
|
|
# If you want full control over the layout of the generated HTML pages it might
|
|
# be necessary to disable the index and replace it with your own. The
|
|
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
|
|
# of each HTML page. A value of NO enables the index and the value YES disables
|
|
# it. Since the tabs in the index contain the same information as the navigation
|
|
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
DISABLE_INDEX = YES
|
|
|
|
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
|
# structure should be generated to display hierarchical information. If the tag
|
|
# value is set to YES, a side panel will be generated containing a tree-like
|
|
# index structure (just like the one that is generated for HTML Help). For this
|
|
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
|
|
# (i.e. any modern browser). Windows users are probably better off using the
|
|
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
|
|
# further fine tune the look of the index (see "Fine-tuning the output"). As an
|
|
# example, the default style sheet generated by doxygen has an example that
|
|
# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
|
|
# Since the tree basically has the same information as the tab index, you could
|
|
# consider setting DISABLE_INDEX to YES when enabling this option.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
GENERATE_TREEVIEW = YES
|
|
|
|
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
|
|
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
|
|
# area (value NO) or if it should extend to the full height of the window (value
|
|
# YES). Setting this to YES gives a layout similar to
|
|
# https://docs.readthedocs.io with more room for contents, but less room for the
|
|
# project logo, title, and description. If either GENERATE_TREEVIEW or
|
|
# DISABLE_INDEX is set to NO, this option has no effect.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
FULL_SIDEBAR = NO
|
|
|
|
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
|
|
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
|
|
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
|
|
# the HTML output. These images will generally look nicer at scaled resolutions.
|
|
# Possible values are: png (the default) and svg (looks nicer but requires the
|
|
# pdf2svg or inkscape tool).
|
|
# The default value is: png.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
HTML_FORMULA_FORMAT = svg
|
|
|
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
|
|
# 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
|
|
# to it using the MATHJAX_RELPATH option.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
USE_MATHJAX = YES
|
|
|
|
# When MathJax is enabled you need to specify the location relative to the HTML
|
|
# output directory using the MATHJAX_RELPATH option. The destination directory
|
|
# should contain the MathJax.js script. For instance, if the mathjax directory
|
|
# is located at the same level as the HTML output directory, then
|
|
# MATHJAX_RELPATH should be ../mathjax. 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 https://www.mathjax.org before deployment. The default value is:
|
|
# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
|
|
# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
|
|
# This tag requires that the tag USE_MATHJAX is set to YES.
|
|
|
|
${CGAL_DOC_MATHJAX_LOCATION_FULL_OPTION_LINE}
|
|
|
|
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
|
|
# extension names that should be enabled during MathJax rendering. For example
|
|
# for MathJax version 2 (see
|
|
# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
|
|
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
|
|
# For example for MathJax version 3 (see
|
|
# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
|
|
# MATHJAX_EXTENSIONS = ams
|
|
# This tag requires that the tag USE_MATHJAX is set to YES.
|
|
|
|
MATHJAX_EXTENSIONS = TeX/AMSmath \
|
|
TeX/AMSsymbols
|
|
|
|
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
|
|
# of code that will be used on startup of the MathJax code. See the MathJax site
|
|
# (see:
|
|
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
|
|
# example see the documentation.
|
|
# This tag requires that the tag USE_MATHJAX is set to YES.
|
|
|
|
MATHJAX_CODEFILE = ${CGAL_DOC_RESOURCE_DIR}/CGAL_mathjax.js
|
|
|
|
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
|
|
# the HTML output. The underlying search engine uses javascript and DHTML and
|
|
# should work on any modern browser. Note that when using HTML help
|
|
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
|
|
# there is already a search function so this one should typically be disabled.
|
|
# For large projects the javascript based search engine can be slow, then
|
|
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
|
|
# search using the keyboard; to jump to the search box use <access key> + S
|
|
# (what the <access key> is depends on the OS and browser, but it is typically
|
|
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
|
|
# key> to jump into the search results window, the results can be navigated
|
|
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
|
|
# the search. The filter options can be selected when the cursor is inside the
|
|
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
|
|
# to select a filter and <Enter> or <escape> to activate or cancel the filter
|
|
# option.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
SEARCHENGINE = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
|
# The default value is: YES.
|
|
|
|
GENERATE_LATEX = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the RTF output
|
|
#---------------------------------------------------------------------------
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the man page output
|
|
#---------------------------------------------------------------------------
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the XML output
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
|
|
# listings (including syntax highlighting and cross-referencing information) to
|
|
# the XML output. Note that enabling this will significantly increase the size
|
|
# of the XML output.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag GENERATE_XML is set to YES.
|
|
|
|
XML_PROGRAMLISTING = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the preprocessor
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
|
|
# in the source code. If set to NO, only conditional compilation will be
|
|
# performed. Macro expansion can be done in a controlled way by setting
|
|
# EXPAND_ONLY_PREDEF to YES.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
|
|
|
MACRO_EXPANSION = YES
|
|
|
|
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
|
|
# the macro expansion is limited to the macros specified with the PREDEFINED and
|
|
# EXPAND_AS_DEFINED tags.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
|
|
|
EXPAND_ONLY_PREDEF = YES
|
|
|
|
# The PREDEFINED tag can be used to specify one or more macro names that are
|
|
# defined before the preprocessor is started (similar to the -D option of e.g.
|
|
# gcc). The argument of the tag is a list of macros of the form: name or
|
|
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
|
|
# is assumed. To prevent a macro definition from being undefined via #undef or
|
|
# recursively expanded use the := operator instead of the = operator.
|
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
|
|
|
PREDEFINED = DOXYGEN_RUNNING \
|
|
"CGAL_NP_TEMPLATE_PARAMETERS=NamedParameters = CGAL::parameters::Default_named_parameters" \
|
|
"CGAL_NP_CLASS=NamedParameters" \
|
|
"CGAL_NP_TEMPLATE_PARAMETERS_1=NamedParameters1 = CGAL::parameters::Default_named_parameter" \
|
|
"CGAL_NP_CLASS_1=NamedParameters1" \
|
|
"CGAL_NP_TEMPLATE_PARAMETERS_2=NamedParameters2 = CGAL::parameters::Default_named_parameter" \
|
|
"CGAL_NP_CLASS_2=NamedParameters2" \
|
|
CGAL_DEPRECATED \
|
|
CGAL_DEPRECATED_MSG(name)=
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to external references
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
|
|
# in the modules index. If set to NO, only the current project's groups will be
|
|
# listed.
|
|
# The default value is: YES.
|
|
|
|
EXTERNAL_GROUPS = NO
|
|
|
|
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
|
|
# the related pages index. If set to NO, only the current project's pages will
|
|
# be listed.
|
|
# The default value is: YES.
|
|
|
|
EXTERNAL_PAGES = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to diagram generator tools
|
|
#---------------------------------------------------------------------------
|
|
|
|
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
|
# available from the path. This tool is part of Graphviz (see:
|
|
# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
|
|
# Bell Labs. The other options in this section have no effect if this option is
|
|
# set to NO
|
|
# The default value is: NO.
|
|
|
|
HAVE_DOT = YES
|
|
|
|
# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
|
|
# generate a graph for each documented class showing the direct and indirect
|
|
# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
|
|
# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
|
|
# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
|
|
# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
|
|
# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
|
|
# relations will be shown as texts / links.
|
|
# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
|
|
# The default value is: YES.
|
|
|
|
CLASS_GRAPH = TEXT
|
|
|
|
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
|
|
# graph for each documented class showing the direct and indirect implementation
|
|
# dependencies (inheritance, containment, and class references variables) of the
|
|
# class with other documented classes.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
COLLABORATION_GRAPH = NO
|
|
|
|
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
|
|
# groups, showing the direct groups dependencies. See also the chapter Grouping
|
|
# in the manual.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
GROUP_GRAPHS = NO
|
|
|
|
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
|
|
# collaboration graphs will show the relations between templates and their
|
|
# instances.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
TEMPLATE_RELATIONS = YES
|
|
|
|
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
|
|
# YES then doxygen will generate a graph for each documented file showing the
|
|
# direct and indirect include dependencies of the file with other documented
|
|
# files.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
INCLUDE_GRAPH = NO
|
|
|
|
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
|
|
# set to YES then doxygen will generate a graph for each documented file showing
|
|
# the direct and indirect include dependencies of the file with other documented
|
|
# files.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
INCLUDED_BY_GRAPH = NO
|
|
|
|
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
|
|
# hierarchy of all classes instead of a textual one.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
GRAPHICAL_HIERARCHY = NO
|
|
|
|
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
|
|
# dependencies a directory has on other directories in a graphical way. The
|
|
# dependency relations are determined by the #include relations between the
|
|
# files in the directories.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
DIRECTORY_GRAPH = NO
|
|
|
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
# generated by dot. For an explanation of the image formats see the section
|
|
# output formats in the documentation of the dot tool (Graphviz (see:
|
|
# https://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, jpg, gif, 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.
|
|
|
|
DOT_IMAGE_FORMAT = svg
|
|
|
|
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
|
# enable generation of interactive SVG images that allow zooming and panning.
|
|
#
|
|
# Note that this requires a modern browser other than Internet Explorer. Tested
|
|
# and working are Firefox, Chrome, Safari, and Opera.
|
|
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
|
|
# the SVG files visible. Older versions of IE do not have SVG support.
|
|
# The default value is: NO.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
INTERACTIVE_SVG = YES
|
|
|
|
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
|
|
# explaining the meaning of the various boxes and arrows in the dot generated
|
|
# graphs.
|
|
# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
|
|
# graphical representation for inheritance and collaboration diagrams is used.
|
|
# The default value is: YES.
|
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
|
GENERATE_LEGEND = NO
|
|
|
|
# Flag available on in https://github.com/CGAL/doxygen/tree/release_1_9_6_patched
|
|
# When the EXTRACT_ALL tag is set to YES and a member or class has no
|
|
# documentation, no detailed section will be produced if the
|
|
# NO_ADDITIONAL_DETAILS tag is set to YES. This tag has no effect if
|
|
# the EXTRACT_ALL tag is set to NO.
|
|
# The default value is: NO.
|
|
${CGAL_OPT_NO_ADDITIONAL_DETAILS}
|
|
|