annotate test/README @ 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 a0e096916474
children
rev   line source
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
2 These are test programs for the SDL library:
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
3
2082
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
4 checkkeys Watch the key events to check the keyboard
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
5 graywin Display a gray gradient and center mouse on spacebar
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
6 loopwave Audio test -- loop playing a WAV file
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
7 testalpha Display an alpha faded icon -- paint with mouse
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
8 testaudioinfo Lists audio device capabilities
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
9 testbitmap Test displaying 1-bit bitmaps
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
10 testblitspeed Tests performance of SDL's blitters and converters.
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
11 testcdrom Sample audio CD control program
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
12 testcursor Tests custom mouse cursor
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
13 testdyngl Tests dynamically loading OpenGL library
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
14 testerror Tests multi-threaded error handling
2082
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
15 testfile Tests RWops layer
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
16 testgamma Tests video device gamma ramp
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
17 testgl A very simple example of using OpenGL with SDL
3070
3e3724fb829e Fixed bug #681
Sam Lantinga <slouken@libsdl.org>
parents: 2082
diff changeset
18 testgl2 An even simpler example using the SDL 1.3 API
2082
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
19 testhread Hacked up test of multi-threading
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
20 testiconv Tests international string conversion
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
21 testjoystick List joysticks and watch joystick events
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
22 testkeys List the available keyboard keys
2082
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
23 testloadso Tests the loadable library layer
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
24 testlock Hacked up test of multi-threading and locking
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
25 testmultiaudio Tests using several audio devices
886
05c551e5bc64 Date: Sat, 24 Apr 2004 15:13:32 +0300
Sam Lantinga <slouken@libsdl.org>
parents: 0
diff changeset
26 testoverlay Tests the software/hardware overlay functionality.
05c551e5bc64 Date: Sat, 24 Apr 2004 15:13:32 +0300
Sam Lantinga <slouken@libsdl.org>
parents: 0
diff changeset
27 testoverlay2 Tests the overlay flickering/scaling during playback.
2082
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
28 testpalette Tests palette color cycling
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
29 testplatform Tests types, endianness and cpu capabilities
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
30 testsem Tests SDL's semaphore implementation
4799
a0e096916474 Rewrote test program for shaped windows. It definitely displays recognizable pictures now, but the resizing and shaping functionality isn't behaving correctly, possibly due to a miscalculation of alpha values.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4770
diff changeset
31 testshape Tests shaped windows
2082
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
32 testsprite Example of fast sprite movement on the screen
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
33 testsprite2 Improved version of testsprite
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
34 testtimer Test the timer facilities
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
35 testver Check the version and dynamic loading and endianness
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
36 testvidinfo Show the pixel format of the display and perfom the benchmark
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
37 testwin Display a BMP image at various depths
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
38 testwm Test window manager -- title, icon, events
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
39 testwm2 Improved version of testwm
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
40 threadwin Test multi-threaded event handling
e6cd882e3ac0 Alpha sort the test list, add missing ones, remove removed ones
Patrice Mandin <patmandin@gmail.com>
parents: 1039
diff changeset
41 torturethread Simple test for thread creation/destruction