mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-06-04 18:54:00 +08:00
update unsupported module documentation to be conformed with new documentation style
This commit is contained in:
parent
b0cb5e6d48
commit
cc444bbbf9
@ -10,16 +10,30 @@ if(CMAKE_COMPILER_IS_GNUCXX)
|
|||||||
endif(CMAKE_SYSTEM_NAME MATCHES Linux)
|
endif(CMAKE_SYSTEM_NAME MATCHES Linux)
|
||||||
endif(CMAKE_COMPILER_IS_GNUCXX)
|
endif(CMAKE_COMPILER_IS_GNUCXX)
|
||||||
|
|
||||||
configure_file(
|
# Set some Doxygen flags
|
||||||
${Eigen_SOURCE_DIR}/unsupported/doc/Doxyfile.in
|
set(EIGEN_DOXY_PROJECT_NAME "Eigen")
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-unsupported
|
set(EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX "")
|
||||||
)
|
set(EIGEN_DOXY_INPUT "\"${Eigen_SOURCE_DIR}/Eigen\" \"${Eigen_SOURCE_DIR}/doc\"")
|
||||||
|
set(EIGEN_DOXY_HTML_COLORSTYLE_HUE "220")
|
||||||
|
set(EIGEN_DOXY_TAGFILES "")
|
||||||
|
|
||||||
configure_file(
|
configure_file(
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
||||||
)
|
)
|
||||||
|
|
||||||
|
set(EIGEN_DOXY_PROJECT_NAME "Eigen-unsupported")
|
||||||
|
set(EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX "/unsupported")
|
||||||
|
set(EIGEN_DOXY_INPUT "\"${Eigen_SOURCE_DIR}/unsupported/Eigen\" \"${Eigen_SOURCE_DIR}/unsupported/doc\"")
|
||||||
|
set(EIGEN_DOXY_HTML_COLORSTYLE_HUE "0")
|
||||||
|
# set(EIGEN_DOXY_TAGFILES "\"${Eigen_BINARY_DIR}/doc/eigen.doxytags =../\"")
|
||||||
|
set(EIGEN_DOXY_TAGFILES "")
|
||||||
|
|
||||||
|
configure_file(
|
||||||
|
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
||||||
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-unsupported
|
||||||
|
)
|
||||||
|
|
||||||
configure_file(
|
configure_file(
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/eigendoxy_header.html.in
|
${CMAKE_CURRENT_SOURCE_DIR}/eigendoxy_header.html.in
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_header.html
|
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_header.html
|
||||||
@ -35,6 +49,11 @@ configure_file(
|
|||||||
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_layout.xml
|
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_layout.xml
|
||||||
)
|
)
|
||||||
|
|
||||||
|
configure_file(
|
||||||
|
${Eigen_SOURCE_DIR}/unsupported/doc/eigendoxy_layout.xml.in
|
||||||
|
${Eigen_BINARY_DIR}/doc/unsupported/eigendoxy_layout.xml
|
||||||
|
)
|
||||||
|
|
||||||
set(examples_targets "")
|
set(examples_targets "")
|
||||||
set(snippets_targets "")
|
set(snippets_targets "")
|
||||||
|
|
||||||
@ -49,12 +68,9 @@ add_custom_target(
|
|||||||
doc-eigen-prerequisites
|
doc-eigen-prerequisites
|
||||||
ALL
|
ALL
|
||||||
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/html/
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/html/
|
||||||
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/eigen_navtree_hacks.js
|
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/eigen_navtree_hacks.js ${CMAKE_CURRENT_BINARY_DIR}/html/
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/html/
|
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Eigen_Silly_Professor_64x64.png ${CMAKE_CURRENT_BINARY_DIR}/html/
|
||||||
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Eigen_Silly_Professor_64x64.png
|
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/AsciiQuickReference.txt ${CMAKE_CURRENT_BINARY_DIR}/html/
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/html/
|
|
||||||
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/AsciiQuickReference.txt
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/html/
|
|
||||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -62,10 +78,8 @@ add_custom_target(
|
|||||||
doc-unsupported-prerequisites
|
doc-unsupported-prerequisites
|
||||||
ALL
|
ALL
|
||||||
COMMAND ${CMAKE_COMMAND} -E make_directory ${Eigen_BINARY_DIR}/doc/html/unsupported
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${Eigen_BINARY_DIR}/doc/html/unsupported
|
||||||
COMMAND ${CMAKE_COMMAND} -E copy ${Eigen_SOURCE_DIR}/doc/eigendoxy_tabs.css
|
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/eigen_navtree_hacks.js ${CMAKE_CURRENT_BINARY_DIR}/html/unsupported/
|
||||||
${Eigen_BINARY_DIR}/doc/html/unsupported/
|
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Eigen_Silly_Professor_64x64.png ${CMAKE_CURRENT_BINARY_DIR}/html/unsupported/
|
||||||
COMMAND ${CMAKE_COMMAND} -E copy ${Eigen_SOURCE_DIR}/doc/Eigen_Silly_Professor_64x64.png
|
|
||||||
${Eigen_BINARY_DIR}/doc/html/unsupported/
|
|
||||||
WORKING_DIRECTORY ${Eigen_BINARY_DIR}/doc
|
WORKING_DIRECTORY ${Eigen_BINARY_DIR}/doc
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -73,9 +87,8 @@ add_dependencies(doc-eigen-prerequisites all_snippets all_examples)
|
|||||||
add_dependencies(doc-unsupported-prerequisites unsupported_snippets unsupported_examples)
|
add_dependencies(doc-unsupported-prerequisites unsupported_snippets unsupported_examples)
|
||||||
|
|
||||||
add_custom_target(doc ALL
|
add_custom_target(doc ALL
|
||||||
COMMAND doxygen Doxyfile-unsupported
|
|
||||||
COMMAND doxygen
|
COMMAND doxygen
|
||||||
COMMAND doxygen Doxyfile-unsupported # run doxygen twice to get proper eigen <=> unsupported cross references
|
COMMAND doxygen Doxyfile-unsupported
|
||||||
COMMAND ${CMAKE_COMMAND} -E rename html eigen-doc
|
COMMAND ${CMAKE_COMMAND} -E rename html eigen-doc
|
||||||
COMMAND ${CMAKE_COMMAND} -E remove eigen-doc/eigen-doc.tgz
|
COMMAND ${CMAKE_COMMAND} -E remove eigen-doc/eigen-doc.tgz
|
||||||
COMMAND ${CMAKE_COMMAND} -E tar cvfz eigen-doc/eigen-doc.tgz eigen-doc
|
COMMAND ${CMAKE_COMMAND} -E tar cvfz eigen-doc/eigen-doc.tgz eigen-doc
|
||||||
|
@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8
|
|||||||
# identify the project. Note that if you do not use Doxywizard you need
|
# identify the project. Note that if you do not use Doxywizard you need
|
||||||
# to put quotes around the project name if it contains spaces.
|
# to put quotes around the project name if it contains spaces.
|
||||||
|
|
||||||
PROJECT_NAME = Eigen
|
PROJECT_NAME = ${EIGEN_DOXY_PROJECT_NAME}
|
||||||
|
|
||||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
||||||
# This could be handy for archiving the generated documentation or
|
# This could be handy for archiving the generated documentation or
|
||||||
@ -54,7 +54,7 @@ PROJECT_LOGO = "${Eigen_SOURCE_DIR}/doc/Eigen_Silly_Professor_64x64.pn
|
|||||||
# If a relative path is entered, it will be relative to the location
|
# If a relative path is entered, it will be relative to the location
|
||||||
# where doxygen was started. If left blank the current directory will be used.
|
# where doxygen was started. If left blank the current directory will be used.
|
||||||
|
|
||||||
OUTPUT_DIRECTORY = "${Eigen_BINARY_DIR}/doc"
|
OUTPUT_DIRECTORY = "${Eigen_BINARY_DIR}/doc${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}"
|
||||||
|
|
||||||
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
||||||
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
||||||
@ -221,7 +221,8 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
|
|||||||
"note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
|
"note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
|
||||||
"note_about_using_kernel_to_study_multiple_solutions=If you need a complete analysis of the space of solutions, take the one solution obtained by this method and add to it elements of the kernel, as determined by kernel()." \
|
"note_about_using_kernel_to_study_multiple_solutions=If you need a complete analysis of the space of solutions, take the one solution obtained by this method and add to it elements of the kernel, as determined by kernel()." \
|
||||||
"note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." \
|
"note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." \
|
||||||
"note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)."
|
"note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." \
|
||||||
|
"nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\"
|
||||||
|
|
||||||
ALIASES += "eigenAutoToc= "
|
ALIASES += "eigenAutoToc= "
|
||||||
ALIASES += "eigenManualPage=\defgroup"
|
ALIASES += "eigenManualPage=\defgroup"
|
||||||
@ -614,7 +615,7 @@ FILE_VERSION_FILTER =
|
|||||||
# You can optionally specify a file name after the option, if omitted
|
# You can optionally specify a file name after the option, if omitted
|
||||||
# DoxygenLayout.xml will be used as the name of the layout file.
|
# DoxygenLayout.xml will be used as the name of the layout file.
|
||||||
|
|
||||||
LAYOUT_FILE = "${Eigen_BINARY_DIR}/doc/eigendoxy_layout.xml"
|
LAYOUT_FILE = "${Eigen_BINARY_DIR}/doc${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}/eigendoxy_layout.xml"
|
||||||
|
|
||||||
# The CITE_BIB_FILES tag can be used to specify one or more bib files
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files
|
||||||
# containing the references data. This must be a list of .bib files. The
|
# containing the references data. This must be a list of .bib files. The
|
||||||
@ -686,8 +687,7 @@ WARN_LOGFILE =
|
|||||||
# directories like "/usr/src/myproject". Separate the files or directories
|
# directories like "/usr/src/myproject". Separate the files or directories
|
||||||
# with spaces.
|
# with spaces.
|
||||||
|
|
||||||
INPUT = "${Eigen_SOURCE_DIR}/Eigen" \
|
INPUT = ${EIGEN_DOXY_INPUT}
|
||||||
"${Eigen_SOURCE_DIR}/doc"
|
|
||||||
|
|
||||||
# This tag can be used to specify the character encoding of the source files
|
# This tag can be used to specify the character encoding of the source files
|
||||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||||
@ -723,7 +723,9 @@ EXCLUDE = "${Eigen_SOURCE_DIR}/Eigen/Eigen2Support" \
|
|||||||
"${Eigen_SOURCE_DIR}/Eigen/src/Eigen2Support" \
|
"${Eigen_SOURCE_DIR}/Eigen/src/Eigen2Support" \
|
||||||
"${Eigen_SOURCE_DIR}/doc/examples" \
|
"${Eigen_SOURCE_DIR}/doc/examples" \
|
||||||
"${Eigen_SOURCE_DIR}/doc/special_examples" \
|
"${Eigen_SOURCE_DIR}/doc/special_examples" \
|
||||||
"${Eigen_SOURCE_DIR}/doc/snippets"
|
"${Eigen_SOURCE_DIR}/doc/snippets" \
|
||||||
|
"${Eigen_SOURCE_DIR}/unsupported/doc/examples" \
|
||||||
|
"${Eigen_SOURCE_DIR}/unsupported/doc/snippets"
|
||||||
|
|
||||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
||||||
# directories that are symbolic links (a Unix file system feature) are excluded
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
||||||
@ -762,7 +764,8 @@ EXCLUDE_PATTERNS = CMake* \
|
|||||||
EXCLUDE_SYMBOLS = internal::* \
|
EXCLUDE_SYMBOLS = internal::* \
|
||||||
Flagged* \
|
Flagged* \
|
||||||
*InnerIterator* \
|
*InnerIterator* \
|
||||||
DenseStorage<*
|
DenseStorage<* \
|
||||||
|
|
||||||
|
|
||||||
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
||||||
# directories that contain example code fragments that are included (see
|
# directories that contain example code fragments that are included (see
|
||||||
@ -773,7 +776,11 @@ EXAMPLE_PATH = "${Eigen_SOURCE_DIR}/doc/snippets" \
|
|||||||
"${Eigen_SOURCE_DIR}/doc/examples" \
|
"${Eigen_SOURCE_DIR}/doc/examples" \
|
||||||
"${Eigen_BINARY_DIR}/doc/examples" \
|
"${Eigen_BINARY_DIR}/doc/examples" \
|
||||||
"${Eigen_SOURCE_DIR}/doc/special_examples" \
|
"${Eigen_SOURCE_DIR}/doc/special_examples" \
|
||||||
"${Eigen_BINARY_DIR}/doc/special_examples"
|
"${Eigen_BINARY_DIR}/doc/special_examples" \
|
||||||
|
"${Eigen_SOURCE_DIR}/unsupported/doc/snippets" \
|
||||||
|
"${Eigen_BINARY_DIR}/unsupported/doc/snippets" \
|
||||||
|
"${Eigen_SOURCE_DIR}/unsupported/doc/examples" \
|
||||||
|
"${Eigen_BINARY_DIR}/unsupported/doc/examples"
|
||||||
|
|
||||||
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
# 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
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
||||||
@ -923,7 +930,7 @@ GENERATE_HTML = YES
|
|||||||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
||||||
# put in front of it. If left blank `html' will be used as the default path.
|
# put in front of it. If left blank `html' will be used as the default path.
|
||||||
|
|
||||||
HTML_OUTPUT = html
|
HTML_OUTPUT = "${Eigen_BINARY_DIR}/doc/html${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}"
|
||||||
|
|
||||||
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
||||||
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
||||||
@ -977,7 +984,7 @@ HTML_EXTRA_FILES = "${Eigen_SOURCE_DIR}/doc/eigendoxy.css"
|
|||||||
# The allowed range is 0 to 359.
|
# The allowed range is 0 to 359.
|
||||||
# The default is 220.
|
# The default is 220.
|
||||||
|
|
||||||
HTML_COLORSTYLE_HUE = 220
|
HTML_COLORSTYLE_HUE = ${EIGEN_DOXY_HTML_COLORSTYLE_HUE}
|
||||||
|
|
||||||
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
||||||
# the colors in the HTML output. For a value of 0 the output will use
|
# the colors in the HTML output. For a value of 0 the output will use
|
||||||
@ -1618,13 +1625,13 @@ SKIP_FUNCTION_MACROS = YES
|
|||||||
# NOT include the path). If a tag file is not located in the directory in which
|
# NOT include the path). If a tag file is not located in the directory in which
|
||||||
# doxygen is run, you must also specify the path to the tagfile here.
|
# doxygen is run, you must also specify the path to the tagfile here.
|
||||||
|
|
||||||
TAGFILES =
|
TAGFILES = ${EIGEN_DOXY_TAGFILES}
|
||||||
# "${Eigen_BINARY_DIR}/doc/eigen-unsupported.doxytags =unsupported"
|
# "${Eigen_BINARY_DIR}/doc/eigen-unsupported.doxytags =unsupported"
|
||||||
|
|
||||||
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
||||||
# a tag file that is based on the input files it reads.
|
# a tag file that is based on the input files it reads.
|
||||||
|
|
||||||
GENERATE_TAGFILE = "${Eigen_BINARY_DIR}/doc/eigen.doxytags"
|
GENERATE_TAGFILE = "${Eigen_BINARY_DIR}/doc/${EIGEN_DOXY_PROJECT_NAME}.doxytags"
|
||||||
|
|
||||||
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
||||||
# in the class index. If set to NO only the inherited external classes
|
# in the class index. If set to NO only the inherited external classes
|
||||||
|
@ -220,7 +220,10 @@ $(document).ready(function() {
|
|||||||
// ok, the default tree has been created, we can keep going...
|
// ok, the default tree has been created, we can keep going...
|
||||||
|
|
||||||
// expand the "Chapters" node
|
// expand the "Chapters" node
|
||||||
expandNode(global_navtree_object, global_navtree_object.node.children[0].children[2], true, true);
|
if(window.location.href.indexOf('unsupported')==-1)
|
||||||
|
expandNode(global_navtree_object, global_navtree_object.node.children[0].children[2], true, true);
|
||||||
|
else
|
||||||
|
expandNode(global_navtree_object, global_navtree_object.node.children[0].children[1], true, true);
|
||||||
|
|
||||||
// Hide the root node "Eigen"
|
// Hide the root node "Eigen"
|
||||||
$(document.getElementsByClassName('index.html')[0]).parent().parent().css({display:"none"});
|
$(document.getElementsByClassName('index.html')[0]).parent().parent().css({display:"none"});
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -10,6 +10,9 @@ Click on the \e Modules tab at the top of this page to get a list of all unsuppo
|
|||||||
|
|
||||||
Don't miss the <a href="..//index.html">official Eigen documentation</a>.
|
Don't miss the <a href="..//index.html">official Eigen documentation</a>.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
\defgroup Unsupported_modules Unsupported modules
|
\defgroup Unsupported_modules Unsupported modules
|
||||||
|
|
||||||
|
177
unsupported/doc/eigendoxy_layout.xml.in
Normal file
177
unsupported/doc/eigendoxy_layout.xml.in
Normal file
@ -0,0 +1,177 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<doxygenlayout version="1.0">
|
||||||
|
<!-- Navigation index tabs for HTML output -->
|
||||||
|
<navindex>
|
||||||
|
<tab type="user" url="index.html" title="Overview" />
|
||||||
|
<tab type="modules" visible="yes" title="Unsupported Modules" intro=""/>
|
||||||
|
<!-- <tab type="mainpage" visible="yes" title=""/> -->
|
||||||
|
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||||
|
<!-- <tab type="classmembers" visible="yes" title="" intro=""/> -->
|
||||||
|
</navindex>
|
||||||
|
|
||||||
|
<!-- Layout definition for a class page -->
|
||||||
|
<class>
|
||||||
|
<briefdescription visible="no"/>
|
||||||
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||||
|
<detaileddescription title=""/>
|
||||||
|
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||||
|
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||||
|
<allmemberslink visible="yes"/>
|
||||||
|
<memberdecl>
|
||||||
|
<nestedclasses visible="yes" title=""/>
|
||||||
|
<publictypes title=""/>
|
||||||
|
<publicslots title=""/>
|
||||||
|
<signals title=""/>
|
||||||
|
<publicmethods title=""/>
|
||||||
|
<publicstaticmethods title=""/>
|
||||||
|
<publicattributes title=""/>
|
||||||
|
<publicstaticattributes title=""/>
|
||||||
|
<protectedtypes title=""/>
|
||||||
|
<protectedslots title=""/>
|
||||||
|
<protectedmethods title=""/>
|
||||||
|
<protectedstaticmethods title=""/>
|
||||||
|
<protectedattributes title=""/>
|
||||||
|
<protectedstaticattributes title=""/>
|
||||||
|
<packagetypes title=""/>
|
||||||
|
<packagemethods title=""/>
|
||||||
|
<packagestaticmethods title=""/>
|
||||||
|
<packageattributes title=""/>
|
||||||
|
<packagestaticattributes title=""/>
|
||||||
|
<properties title=""/>
|
||||||
|
<events title=""/>
|
||||||
|
<privatetypes title=""/>
|
||||||
|
<privateslots title=""/>
|
||||||
|
<privatemethods title=""/>
|
||||||
|
<privatestaticmethods title=""/>
|
||||||
|
<privateattributes title=""/>
|
||||||
|
<privatestaticattributes title=""/>
|
||||||
|
<friends title=""/>
|
||||||
|
<related title="" subtitle=""/>
|
||||||
|
<membergroups visible="yes"/>
|
||||||
|
</memberdecl>
|
||||||
|
|
||||||
|
<memberdef>
|
||||||
|
<inlineclasses title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<constructors title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<related title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
<properties title=""/>
|
||||||
|
<events title=""/>
|
||||||
|
</memberdef>
|
||||||
|
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||||
|
<authorsection visible="yes"/>
|
||||||
|
</class>
|
||||||
|
|
||||||
|
<!-- Layout definition for a namespace page -->
|
||||||
|
<namespace>
|
||||||
|
<briefdescription visible="yes"/>
|
||||||
|
<memberdecl>
|
||||||
|
<nestednamespaces visible="yes" title=""/>
|
||||||
|
<classes visible="yes" title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
<membergroups visible="yes"/>
|
||||||
|
</memberdecl>
|
||||||
|
<detaileddescription title=""/>
|
||||||
|
<memberdef>
|
||||||
|
<inlineclasses title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
</memberdef>
|
||||||
|
<authorsection visible="yes"/>
|
||||||
|
</namespace>
|
||||||
|
|
||||||
|
<!-- Layout definition for a file page -->
|
||||||
|
<file>
|
||||||
|
<briefdescription visible="yes"/>
|
||||||
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||||
|
<includegraph visible="$INCLUDE_GRAPH"/>
|
||||||
|
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
||||||
|
<sourcelink visible="yes"/>
|
||||||
|
<memberdecl>
|
||||||
|
<classes visible="yes" title=""/>
|
||||||
|
<namespaces visible="yes" title=""/>
|
||||||
|
<defines title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
<membergroups visible="yes"/>
|
||||||
|
</memberdecl>
|
||||||
|
<detaileddescription title=""/>
|
||||||
|
<memberdef>
|
||||||
|
<inlineclasses title=""/>
|
||||||
|
<defines title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
</memberdef>
|
||||||
|
<authorsection/>
|
||||||
|
</file>
|
||||||
|
|
||||||
|
<!-- Layout definition for a group page -->
|
||||||
|
<group>
|
||||||
|
<briefdescription visible="no"/>
|
||||||
|
<detaileddescription title=""/>
|
||||||
|
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||||
|
<memberdecl>
|
||||||
|
<nestedgroups visible="yes" title=""/>
|
||||||
|
<dirs visible="yes" title=""/>
|
||||||
|
<files visible="yes" title=""/>
|
||||||
|
<namespaces visible="yes" title=""/>
|
||||||
|
<classes visible="yes" title=""/>
|
||||||
|
<defines title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<enumvalues title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
<signals title=""/>
|
||||||
|
<publicslots title=""/>
|
||||||
|
<protectedslots title=""/>
|
||||||
|
<privateslots title=""/>
|
||||||
|
<events title=""/>
|
||||||
|
<properties title=""/>
|
||||||
|
<friends title=""/>
|
||||||
|
<membergroups visible="yes"/>
|
||||||
|
</memberdecl>
|
||||||
|
|
||||||
|
<memberdef>
|
||||||
|
<pagedocs/>
|
||||||
|
<inlineclasses title=""/>
|
||||||
|
<defines title=""/>
|
||||||
|
<typedefs title=""/>
|
||||||
|
<enums title=""/>
|
||||||
|
<enumvalues title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
|
<signals title=""/>
|
||||||
|
<publicslots title=""/>
|
||||||
|
<protectedslots title=""/>
|
||||||
|
<privateslots title=""/>
|
||||||
|
<events title=""/>
|
||||||
|
<properties title=""/>
|
||||||
|
<friends title=""/>
|
||||||
|
</memberdef>
|
||||||
|
<authorsection visible="yes"/>
|
||||||
|
</group>
|
||||||
|
|
||||||
|
<!-- Layout definition for a directory page -->
|
||||||
|
<directory>
|
||||||
|
<briefdescription visible="yes"/>
|
||||||
|
<directorygraph visible="yes"/>
|
||||||
|
<memberdecl>
|
||||||
|
<dirs visible="yes"/>
|
||||||
|
<files visible="yes"/>
|
||||||
|
</memberdecl>
|
||||||
|
<detaileddescription title=""/>
|
||||||
|
</directory>
|
||||||
|
</doxygenlayout>
|
Loading…
x
Reference in New Issue
Block a user