aboutsummaryrefslogtreecommitdiffhomepage
path: root/Doxyfile
diff options
context:
space:
mode:
authorGravatar tomhudson@google.com <tomhudson@google.com@2bbb7eff-a529-9590-31e7-b0007b416f81>2011-12-01 20:41:24 +0000
committerGravatar tomhudson@google.com <tomhudson@google.com@2bbb7eff-a529-9590-31e7-b0007b416f81>2011-12-01 20:41:24 +0000
commit05fffdcc912cb9678e03d39529577e2a29b9209e (patch)
tree4277122a7f619774882148e55f6728982e8e5a14 /Doxyfile
parent9aa9f5b787be542fcefb22b1c7be29c2eb9e27c6 (diff)
Doxygen configuration file, documentation and minor cleanup on blitters.
git-svn-id: http://skia.googlecode.com/svn/trunk@2782 2bbb7eff-a529-9590-31e7-b0007b416f81
Diffstat (limited to 'Doxyfile')
-rw-r--r--Doxyfile45
1 files changed, 45 insertions, 0 deletions
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000000..a1c7e4f10b
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,45 @@
+PROJECT_NAME = skia
+PROJECT_BRIEF = 2D Graphics Library
+OUTPUT_DIRECTORY = doc
+
+EXTRACT_ALL = NO
+INHERIT_DOCS = YES
+INLINE_INHERITED_MEMB = NO
+JAVADOC_AUTOBRIEF = YES
+TAB_SIZE = 4
+WARN_IF_UNDOCUMENTED = NO
+
+# This file only creates documentation for the most important parts of the
+# external-visible API.
+INPUT = include/core include/effects
+EXTRACT_PRIVATE = YES
+EXTRACT_STATIC = YES
+
+HTML_DYNAMIC_SECTIONS = NO
+GENERATE_TREEVIEW = YES
+
+GENERATE_LATEX = NO
+
+# Good class diagrams require graphviz, but also more parameter tuning and
+# more build time than seems worthwhile.
+CLASS_DIAGRAMS = YES
+# HAVE_DOT = YES
+# CLASS_GRAPH = YES
+# COLLABORATION_GRAPH = YES
+# UML_LOOK = YES
+# GRAPHICAL_HIERARCHY = YES
+
+# Make SkDEBUGCODE disappear, but not SK_OVERRIDE.
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = YES
+EXPAND_AS_DEFINED = SkDEBUGCODE
+
+# experimental evil only! inflates build time by 10 minutes
+# SEARCH_INCLUDES = YES
+# INCLUDE_GRAPH = YES
+# INCLUDED_BY_GRAPH = YES
+# DIRECTORY_GRAPH = YES
+# INTERACTIVE_SVG = YES
+
+