Improve Doxyfile

ShadowNinja · ShadowNinja · commit bd40ee2b9513 · 2016-01-04T11:32:03.000-05:00
* 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.
diff --git 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
 
