diff options
| author | ShadowNinja <shadowninja@minetest.net> | 2015-12-06 21:34:30 -0500 |
|---|---|---|
| committer | ShadowNinja <shadowninja@minetest.net> | 2016-01-04 11:32:03 -0500 |
| commit | bd40ee2b95138139a8cfbef878b3461176688c15 (patch) | |
| tree | 6318e43b061efae685a9efda986a5829f7bc405b /doc | |
| parent | e7e9171f37730c34dd687aa2b9ca5392aa41e46b (diff) | |
| download | minetest-bd40ee2b95138139a8cfbef878b3461176688c15.tar.gz minetest-bd40ee2b95138139a8cfbef878b3461176688c15.tar.bz2 minetest-bd40ee2b95138139a8cfbef878b3461176688c15.zip | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile.in | 43 |
1 files changed, 31 insertions, 12 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index d35fbf65f..3618b852d 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,34 +1,53 @@ -DOXYFILE_ENCODING = UTF-8 - -PROJECT_NAME = "Minetest" +# Project properties +PROJECT_NAME = @PROJECT_NAME_CAPITALIZED@ PROJECT_NUMBER = @VERSION_STRING@ +PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/misc/minetest.svg -STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@/src +# Parsing JAVADOC_AUTOBRIEF = YES EXTRACT_ALL = YES EXTRACT_PRIVATE = YES EXTRACT_STATIC = YES SORT_MEMBERS_CTORS_1ST = YES WARN_IF_UNDOCUMENTED = NO +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" -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ \ +# 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/ \ @CMAKE_CURRENT_SOURCE_DIR@/src/client \ @CMAKE_CURRENT_SOURCE_DIR@/src/network \ @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 \ - @CMAKE_CURRENT_SOURCE_DIR@/src/script/lua_api -RECURSIVE = NO - -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES -GENERATE_LATEX = NO -PAPER_TYPE = a4wide + @CMAKE_CURRENT_SOURCE_DIR@/src/script/lua_api \ + @CMAKE_CURRENT_SOURCE_DIR@/src/threading +# Dot graphs HAVE_DOT = @DOXYGEN_DOT_FOUND@ CALL_GRAPH = YES CALLER_GRAPH = YES MAX_DOT_GRAPH_DEPTH = 3 DOT_MULTI_TARGETS = YES +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 |