epoger@google.com | c62b0f8 | 2011-12-02 17:13:36 +0000 | [diff] [blame^] | 1 | # 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.com | 05fffdc | 2011-12-01 20:41:24 +0000 | [diff] [blame] | 25 | PROJECT_NAME = skia |
| 26 | PROJECT_BRIEF = 2D Graphics Library |
epoger@google.com | c62b0f8 | 2011-12-02 17:13:36 +0000 | [diff] [blame^] | 27 | OUTPUT_DIRECTORY = ../docs |
tomhudson@google.com | 05fffdc | 2011-12-01 20:41:24 +0000 | [diff] [blame] | 28 | |
| 29 | EXTRACT_ALL = NO |
| 30 | INHERIT_DOCS = YES |
| 31 | INLINE_INHERITED_MEMB = NO |
| 32 | JAVADOC_AUTOBRIEF = YES |
| 33 | TAB_SIZE = 4 |
| 34 | WARN_IF_UNDOCUMENTED = NO |
| 35 | |
| 36 | # This file only creates documentation for the most important parts of the |
| 37 | # external-visible API. |
| 38 | INPUT = include/core include/effects |
| 39 | EXTRACT_PRIVATE = YES |
| 40 | EXTRACT_STATIC = YES |
| 41 | |
| 42 | HTML_DYNAMIC_SECTIONS = NO |
| 43 | GENERATE_TREEVIEW = YES |
| 44 | |
| 45 | GENERATE_LATEX = NO |
| 46 | |
| 47 | # Good class diagrams require graphviz, but also more parameter tuning and |
| 48 | # more build time than seems worthwhile. |
| 49 | CLASS_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. |
| 57 | ENABLE_PREPROCESSING = YES |
| 58 | MACRO_EXPANSION = YES |
| 59 | EXPAND_ONLY_PREDEF = YES |
| 60 | EXPAND_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 | |