blob: 69c9ddb439a66b9c2c8d76dd9f204d1fb6f5508b [file] [log] [blame]
epoger@google.comc62b0f82011-12-02 17:13:36 +00001# How to run doxygen and store its results in the Skia repo, so that they can be
2# browsed at http://skia.googlecode.com/svn/docs/html/index.html :
3#
4# cd
5# TEMPDIR=/tmp/skia-doxygen
6# rm -rf $TEMPDIR
7# mkdir -p $TEMPDIR
8# cd $TEMPDIR
9# svn checkout https://skia.googlecode.com/svn/trunk
10# svn checkout https://skia.googlecode.com/svn/docs
11# cd trunk
12# doxygen Doxyfile
13# cd ../docs
14# NEWFILES=$(svn status | grep ^\? | awk '{print $2}')
15# svn add $NEWFILES
16# find . -name *.html -exec svn propset svn:mime-type text/html '{}' \;
17# find . -name *.css -exec svn propset svn:mime-type text/css '{}' \;
18# find . -name *.js -exec svn propset svn:mime-type text/javascript '{}' \;
19# find . -name *.gif -exec svn propset svn:mime-type image/gif '{}' \;
20# find . -name *.png -exec svn propset svn:mime-type image/png '{}' \;
21# svn commit --message 'commit doxygen-generated documentation'
22# cd
23# rm -rf $TEMPDIR
24
tomhudson@google.com05fffdc2011-12-01 20:41:24 +000025PROJECT_NAME = skia
26PROJECT_BRIEF = 2D Graphics Library
epoger@google.comc62b0f82011-12-02 17:13:36 +000027OUTPUT_DIRECTORY = ../docs
tomhudson@google.com05fffdc2011-12-01 20:41:24 +000028
29EXTRACT_ALL = NO
30INHERIT_DOCS = YES
31INLINE_INHERITED_MEMB = NO
32JAVADOC_AUTOBRIEF = YES
33TAB_SIZE = 4
34WARN_IF_UNDOCUMENTED = NO
35
36# This file only creates documentation for the most important parts of the
37# external-visible API.
38INPUT = include/core include/effects
39EXTRACT_PRIVATE = YES
40EXTRACT_STATIC = YES
41
42HTML_DYNAMIC_SECTIONS = NO
43GENERATE_TREEVIEW = YES
44
45GENERATE_LATEX = NO
46
47# Good class diagrams require graphviz, but also more parameter tuning and
48# more build time than seems worthwhile.
49CLASS_DIAGRAMS = YES
50# HAVE_DOT = YES
51# CLASS_GRAPH = YES
52# COLLABORATION_GRAPH = YES
53# UML_LOOK = YES
54# GRAPHICAL_HIERARCHY = YES
55
56# Make SkDEBUGCODE disappear, but not SK_OVERRIDE.
57ENABLE_PREPROCESSING = YES
58MACRO_EXPANSION = YES
59EXPAND_ONLY_PREDEF = YES
60EXPAND_AS_DEFINED = SkDEBUGCODE
61
62# experimental evil only! inflates build time by 10 minutes
63# SEARCH_INCLUDES = YES
64# INCLUDE_GRAPH = YES
65# INCLUDED_BY_GRAPH = YES
66# DIRECTORY_GRAPH = YES
67# INTERACTIVE_SVG = YES
68
69