moparisthebest/minetest
1
0
Fork 0
mirror of https://github.com/moparisthebest/minetest synced 2024-11-16 14:25:19 -05:00
Code Issues Releases Wiki Activity
edba6e50d9
minetest/doc/Doxyfile.in

54 lines
1.5 KiB
Plaintext
Raw Normal View History

Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
# Project properties
PROJECT_NAME = @PROJECT_NAME_CAPITALIZED@
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
PROJECT_NUMBER = @VERSION_STRING@
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/misc/minetest.svg
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
# Parsing
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
JAVADOC_AUTOBRIEF = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
SORT_MEMBERS_CTORS_1ST = YES
WARN_IF_UNDOCUMENTED = NO
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
BUILTIN_STL_SUPPORT = YES
PREDEFINED = "USE_SPATIAL=1" \
"USE_LEVELDB=1" \
"USE_REDIS=1" \
"USE_SOUND=1" \
"USE_CURL=1" \
"USE_FREETYPE=1" \
"USE_GETTEXT=1"
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
# Input
RECURSIVE = NO
STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@/src
INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doc/main_page.dox \
@CMAKE_CURRENT_SOURCE_DIR@/src/ \
Add two missing directories to doxygen
2015-09-01 16:36:12 -04:00
@CMAKE_CURRENT_SOURCE_DIR@/src/client \
@CMAKE_CURRENT_SOURCE_DIR@/src/network \
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
@CMAKE_CURRENT_SOURCE_DIR@/src/util \
@CMAKE_CURRENT_SOURCE_DIR@/src/script \
@CMAKE_CURRENT_SOURCE_DIR@/src/script/common \
@CMAKE_CURRENT_SOURCE_DIR@/src/script/cpp_api \
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
@CMAKE_CURRENT_SOURCE_DIR@/src/script/lua_api \
@CMAKE_CURRENT_SOURCE_DIR@/src/threading
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
# Dot graphs
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
HAVE_DOT = @DOXYGEN_DOT_FOUND@
CALL_GRAPH = YES
CALLER_GRAPH = YES
MAX_DOT_GRAPH_DEPTH = 3
DOT_MULTI_TARGETS = YES
Improve Doxyfile * Add main page. * Organize into sections. * Add threading sources. * Include SpatialAreaStore, LevelDB/Redis, sound, FreeType, and cURL in output. * Add logo. * Fix project name hardcoding. * Remove PAPER_TYPE (only used when GENERATE_LATEX is enabled). * Have dot render graphs as SVG (smaller, and works even if dot's text drawing functionality is broken). * Enable built-in STL support. * Enable search bar. * Switch from header-bar based navigation to treeview based navigation. * Enable dynamic HTML (collapses graphs). * Enable generation timestamp.
2015-12-06 21:34:30 -05:00
DOT_IMAGE_FORMAT = svg
# Output
GENERATE_LATEX = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
SEARCHENGINE = YES
DISABLE_INDEX = YES
GENERATE_TREEVIEW = YES
HTML_DYNAMIC_SECTIONS = YES
HTML_TIMESTAMP = YES
Add basic support for generating API documentation using Doxygen If CMake is run and Doxygen is found, add a make target called "doc", which builds API documention in doc/html. This target is not included in the default "all" target, you have to explicitly run "make doc" to generate the documentation. If graphviz is installed, in particular, if the "dot" binary is found, doxygen is configured to generate various kinds of diagrams. Note that due to this, the first run of doxygen can take a while.
2013-01-30 12:21:32 -05:00
Reference in New Issue Copy Permalink