[docs] Add a basic doxyfile
authorJon Purdy <evincarofautumn@gmail.com>
Thu, 26 Jan 2017 22:11:07 +0000 (14:11 -0800)
committerAlexander Köplinger <alex.koeplinger@outlook.com>
Sat, 28 Jan 2017 02:39:07 +0000 (03:39 +0100)
Bare minimum Doxygen configuration with dependency graphs.

docs/.gitignore
docs/Makefile.am
docs/doxyfile [new file with mode: 0644]

index 1be487d448de63b638063a41f4549e0736e604cc..277d820ae1f32b800ac18d752f90c8c8d1a8965f 100644 (file)
@@ -9,3 +9,4 @@
 /mono-tools.tree
 /mono-tools.zip
 /AgilityPack.dll*
+/doxygen-output
index f9d4ac6b51058a104070ae56ca2ba934406cf254..99652f30dc5bbc41b41ddf6487e3087cb6d9f736 100644 (file)
@@ -64,6 +64,7 @@ dist-hook:
 
 clean-local:
        -rm -Rf html
+       -rm -Rf doxygen-output
        -rm -f deploy/* convert.exe* AgilityPack.dll*
        -rm -f $(ASSEMBLED_DOCS)
 
@@ -100,3 +101,7 @@ convert.exe: convert.cs AgilityPack.dll
 AgilityPack.dll: 
        $(TOOL_MAKE) AgilityPack.dll
 
+doxygen:
+       doxygen doxyfile
+
+.PHONY: doxygen
diff --git a/docs/doxyfile b/docs/doxyfile
new file mode 100644 (file)
index 0000000..9c0e6b2
--- /dev/null
@@ -0,0 +1,92 @@
+ALLOW_UNICODE_NAMES = NO
+ALPHABETICAL_INDEX = YES
+ALWAYS_DETAILED_SEC = NO
+AUTOLINK_SUPPORT = YES
+BRIEF_MEMBER_DESC = YES
+CALLER_GRAPH = YES
+CALL_GRAPH = YES
+CASE_SENSE_NAMES = NO
+CLASS_DIAGRAMS = YES
+COLS_IN_ALPHA_INDEX = 1
+CREATE_SUBDIRS = NO
+DIRECTORY_GRAPH = YES
+DOT_CLEANUP = YES
+DOT_IMAGE_FORMAT = svg
+DOT_MULTI_TARGETS = YES
+DOXYFILE_ENCODING = UTF-8
+ENABLE_PREPROCESSING = YES
+ENUM_VALUES_PER_LINE = 1
+EXCLUDE_SYMLINKS = NO
+EXPAND_ONLY_PREDEF = NO
+EXTENSION_MAPPING = c=C h=C
+EXTRACT_ALL = YES
+EXTRACT_STATIC = YES
+EXT_LINKS_IN_WINDOW = NO
+FILE_PATTERNS = *.c *.h
+FULL_PATH_NAMES = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST = YES
+GENERATE_HTML = YES
+GENERATE_PERLMOD = YES
+GENERATE_LEGEND = YES
+GENERATE_TESTLIST = YES
+GENERATE_TODOLIST = YES
+GENERATE_TREEVIEW = YES
+GRAPHICAL_HIERARCHY = YES
+HAVE_DOT = YES
+HIDE_UNDOC_RELATIONS = YES
+HTML_COLORSTYLE_GAMMA = 80
+HTML_COLORSTYLE_HUE = 220
+HTML_COLORSTYLE_SAT = 100
+HTML_DYNAMIC_SECTIONS = YES
+HTML_FILE_EXTENSION = .html
+HTML_INDEX_NUM_ENTRIES = 100
+HTML_OUTPUT = doxygen
+HTML_TIMESTAMP = YES
+INCLUDED_BY_GRAPH = YES
+INCLUDE_GRAPH = YES
+INHERIT_DOCS = YES
+INLINE_INHERITED_MEMB = NO
+INLINE_SOURCES = YES
+INPUT = ../mono
+INPUT_ENCODING = UTF-8
+INTERACTIVE_SVG = YES
+JAVADOC_AUTOBRIEF = NO
+LOOKUP_CACHE_SIZE = 0
+MACRO_EXPANSION = NO
+MARKDOWN_SUPPORT = YES
+MAX_INITIALIZER_LINES = 30
+MULTILINE_CPP_IS_BRIEF = NO
+OPTIMIZE_OUTPUT_FOR_C = YES
+OUTPUT_DIRECTORY = doxygen-output
+OUTPUT_LANGUAGE = English
+PROJECT_NAME = "Mono"
+QT_AUTOBRIEF = NO
+QUIET = NO
+RECURSIVE = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_LINK_SOURCE = YES
+REFERENCES_RELATION = YES
+REPEAT_BRIEF = YES
+SEARCHENGINE = YES
+SEARCH_INCLUDES = YES
+SEPARATE_MEMBER_PAGES = NO
+SHORT_NAMES = NO
+SHOW_FILES = YES
+SHOW_USED_FILES = YES
+SKIP_FUNCTION_MACROS = YES
+SORT_BRIEF_DOCS = YES
+SORT_GROUP_NAMES = YES
+SOURCE_BROWSER = YES
+SOURCE_TOOLTIPS = YES
+STRIP_CODE_COMMENTS = NO
+TAB_SIZE = 4
+TREEVIEW_WIDTH = 250
+TYPEDEF_HIDES_STRUCT = NO
+USE_HTAGS = NO
+USE_MDFILE_AS_MAINPAGE = ../README.md
+VERBATIM_HEADERS = YES
+WARNINGS = YES
+WARN_IF_DOC_ERROR = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_NO_PARAMDOC = NO