annotate .hgignore @ 5067:61d53410eb41

Fixed bug #859 CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser. ALWAYS_DETAILED_SEC makes sure everything has at least the automatic documentation like function prototype and source references. STRIP_FROM_PATH allows you to include only the relevant portions of the files' paths, cleaning up both the file list and directory tree, though you need to change the path listed here to match wherever you put SDL. ALIASES avoids some warnings generated by C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h. It seems Apple uses a few commands which are not normally supported by Doxygen. BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the standard template library. There isn't a lot of C++ in SDL (some in bwindow at least), but this still seems like a good idea. TYPEDEF_HIDES_STRUCT means that for code like this: typedef struct A {int B;} C; C is documented as a structure containing B instead of a typedef mapped to A. EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS, EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is documented. CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on case insensitive file systems like NTFS and FAT32. WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of the parameters of a function. This is useful when you're working on adding such documentation since it makes partially documented functions easier to spot. WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with stdout. When not running in quiet mode, these warnings can be hard to spot without this flag. I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for config.h.in and config.h.default. RECURSIVE tells doxygen to look not only in the input directory, but also in subfolders. EXCLUDE avoids documenting things like test programs, examples and templates which need to be documented separately. I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find their way into source folders (such as obj or .svn). EXAMPLE_PATH lists directories doxygen will search to find included example code. So far, SDL doesn't really use this feature, but I've listed some likely locations. SOURCE_BROWSER adds syntax highlighted source code to the HTML output. USE_HTAGS is nice, but not available on Windows. INLINE_SOURCES adds the body of a function to it's documentation so you can quickly see exactly what it does. ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions, etc., which makes it much easier to find what you're looking for. IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an item on so you don't have everything show up under "S". HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and adds JavaScript to allow the user to show and hide them by clicking a link. ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on it's own line. GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the left. I have LaTeX and man pages turned off to speed up doxygen, you may want to turn them back on yourself. I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to Win32 builds of SDL. Normally, doxygen gets confused since there are multiple definitions for various structures and formats that vary by platform. Without this doxygen can produce broken documentation or, if you're lucky, output documentation only for the dummy drivers, which isn't very useful. You need to pick a platform. GENERATE_TAGFILE produces a file which can be used to link other doxygen documentation to the SDL documentation. CLASS_DIAGRAMS turns on class diagrams even when dot is not available. HAVE_DOT tells doxygen to try to use dot to generate diagrams. TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the documentation. DOT_MULTI_TARGETS speeds up dot. OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is intended to process src as well as include and is being run from a separate subdirectory. Doxygen produces several temporary files while it's running and if interrupted, can leave those files behind. It's easier to clean up if there aren't a hundred or so files in the same folder. I typically run doxygen in SDL/doxy and set the output directory to '.'. Since doxygen puts it's output in subfolders by type, this keeps things pretty well organised. You could use '../doc' instead and get the same results.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 21 Jan 2011 12:57:01 -0800
parents 7b1d35d98294
children
rev   line source
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
1 syntax:glob
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
2 aclocal.m4
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3 autom4te*
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
4 config.cache
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5 config.log
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
6 config.status
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
7 configure
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
8 libtool
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
9 Makefile
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
10 sdl-config
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
11 SDL.spec
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
12 SDL.qpg
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
13 build
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14 build-deps
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
15 VisualC
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
16 VisualCE
4466
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
17 # for Xcode
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
18 *.orig
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
19 *.swp
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
20 *.tmp
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
21 *.rej
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
22 *~
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
23 *.o
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
24 *.mode1*
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
25 *.model*
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
26 *.perspective*
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
27 *.perspective*
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
28 *.pbxuser
ba66ff156955 Added the automated test plist file and modified .hgignore to be less aggressive.
Eric Wing <ewing . public |-at-| gmail . com>
parents: 4418
diff changeset
29 (^|/)build($|/)
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
30 .DS_Store
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
31 sdl.pc
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
32 include/SDL_config.h
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
33 include/SDL_revision.h
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
34 test/aclocal.m4
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
35 test/autom4te*
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
36 test/config.cache
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
37 test/config.log
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
38 test/config.status
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
39 test/configure
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
40 test/Makefile
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
41 test/SDL.dll
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
42 test/stdout.txt
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
43 test/stderr.txt
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
44 test/checkkeys
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
45 test/graywin
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
46 test/loopwave
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
47 test/testalpha
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
48 test/testatomic
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
49 test/testaudioinfo
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
50 test/testbitmap
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
51 test/testblitspeed
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
52 test/testcdrom
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
53 test/testcursor
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
54 test/testdraw2
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
55 test/testdyngl
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
56 test/testdyngles
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
57 test/testerror
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
58 test/testeyes
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
59 test/testfile
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
60 test/testfill
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
61 test/testgamma
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
62 test/testgesture
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
63 test/testgl
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
64 test/testgl2
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
65 test/testgles
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
66 test/testhaptic
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
67 test/testhread
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
68 test/testiconv
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
69 test/testime
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
70 test/testintersections
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
71 test/testjoystick
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
72 test/testkeys
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
73 test/testloadso
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
74 test/testlock
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
75 test/testmmousetablet
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
76 test/testmultiaudio
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
77 test/testoverlay
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
78 test/testoverlay2
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
79 test/testpalette
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
80 test/testplatform
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
81 test/testpower
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
82 test/testresample
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
83 test/testsem
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
84 test/testsprite
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
85 test/testsprite2
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
86 test/testspriteminimal
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
87 test/testtimer
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
88 test/testver
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
89 test/testvidinfo
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
90 test/testwin
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
91 test/testwm
4862
7b1d35d98294 Merged Eli's Google Summer of Code work from SDL-gsoc2010-shaped_windows
Sam Lantinga <slouken@libsdl.org>
parents: 4691 4792
diff changeset
92 test/testwm2
4418
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
93 test/threadwin
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
94 test/torturethread
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
95 test/*.exe
be1929ccaa3d Made an .hgignore to mostly match old svn:ignore properties.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
96 test/*.dSYM