Mercurial > sdl-ios-xcode

comparison include/doxyfile @ 5109:30da7089dcb4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Only document the public API, not the whole source tree.
author Sam Lantinga <slouken@libsdl.org>
date Thu, 27 Jan 2011 07:05:13 -0800
parents 61d53410eb41
children
comparison
equal deleted inserted replaced
5108:d547877e355e 5109:30da7089dcb4
122 # only done if one of the specified strings matches the left-hand part of 122 # only done if one of the specified strings matches the left-hand part of
123 # the path. The tag can be used to show relative paths in the file list. 123 # the path. The tag can be used to show relative paths in the file list.
124 # If left blank the directory from which doxygen is run is used as the 124 # If left blank the directory from which doxygen is run is used as the
125 # path to strip. 125 # path to strip.
126 126
127 STRIP_FROM_PATH = ../ \ 127 STRIP_FROM_PATH =
128 C:/source/svn.libsdl.org/trunk/ \
129 C:\source\svn.libsdl.org\trunk\ \
130 ..\
131 128
132 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
133 # the path mentioned in the documentation of a class, which tells 130 # the path mentioned in the documentation of a class, which tells
134 # the reader which header file to include in order to use a class. 131 # the reader which header file to include in order to use a class.
135 # If left blank only the name of the header file containing the class 132 # If left blank only the name of the header file containing the class
570 # The INPUT tag can be used to specify the files and/or directories that contain 567 # The INPUT tag can be used to specify the files and/or directories that contain
571 # documented source files. You may enter file names like "myfile.cpp" or 568 # documented source files. You may enter file names like "myfile.cpp" or
572 # directories like "/usr/src/myproject". Separate the files or directories 569 # directories like "/usr/src/myproject". Separate the files or directories
573 # with spaces. 570 # with spaces.
574 571
575 INPUT = .. 572 INPUT = .
576 573
577 # This tag can be used to specify the character encoding of the source files 574 # This tag can be used to specify the character encoding of the source files
578 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 575 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
579 # also the default input encoding. Doxygen uses libiconv (or the iconv built 576 # also the default input encoding. Doxygen uses libiconv (or the iconv built
580 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 577 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
650 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 647 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
651 # certain files from those directories. Note that the wildcards are matched 648 # certain files from those directories. Note that the wildcards are matched
652 # against the file with absolute path, so to exclude all test directories 649 # against the file with absolute path, so to exclude all test directories
653 # for example use the pattern */test/* 650 # for example use the pattern */test/*
654 651
655 EXCLUDE_PATTERNS = */.svn/* \ 652 EXCLUDE_PATTERNS =
656 */bin/* \
657 */lib/* \
658 */obj/*
659 653
660 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 654 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
661 # (namespaces, classes, functions, etc.) that should be excluded from the 655 # (namespaces, classes, functions, etc.) that should be excluded from the
662 # output. The symbol name can be a fully qualified name, a word, or if the 656 # output. The symbol name can be a fully qualified name, a word, or if the
663 # wildcard * is used, a substring. Examples: ANamespace, AClass, 657 # wildcard * is used, a substring. Examples: ANamespace, AClass,
667 661
668 # The EXAMPLE_PATH tag can be used to specify one or more files or 662 # The EXAMPLE_PATH tag can be used to specify one or more files or
669 # directories that contain example code fragments that are included (see 663 # directories that contain example code fragments that are included (see
670 # the \include command). 664 # the \include command).
671 665
672 EXAMPLE_PATH = ../test \ 666 EXAMPLE_PATH =
673 ../Xcode \
674 ../Xcode-iPhoneOS
675 667
676 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 668 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
677 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 669 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
678 # and *.h) to filter out the source-files in the directories. If left 670 # and *.h) to filter out the source-files in the directories. If left
679 # blank all files are included. 671 # blank all files are included.