annotate TODO @ 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 d79939f20c45
children
rev   line source
4788
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
1 Eli Gottlieb's checklist for the GSOC shaped windows project. Dated July 9, 2010.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
2 1. Enable proper linking of the X11 implementation and test it.
4810
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
3 --> Find the place in the build system for platform-specific linking flags. STATUS: DONE
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
4 --> Add a linker flag to bring in libXext.a. STATUS: DONE.
4788
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
5 2. Build the Win32 implementation of shaped-windows functionality.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
6 --> Add driver functions to the SDL_ShapeDriver in the Win32 driver's SDL_DisplayDevice at the proper point in the code. STATUS: CHECK.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
7 --> Add a hook in the Windows resize-window code to call Win32_ResizeWindowShape(). STATUS: CHECK.
4810
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
8 --> Get the Windows code to build and run properly. STATUS: IN PROGRESS.
4788
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
9 3. Enable building the testeyes program.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
10 --> Reprogram it to use the latest shaped-windows API. STATUS: CHECK.
4810
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
11 --> Get it, along with the rest of the test suite in my branch, building successfully. STATUS: DONE.
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
12 --> Debug testeyes and the platform-specific shaped-window implementations in tandem. STATUS: IN PROGRESS.
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
13 4. Implement the SDL shaped-windows API for Mac OS X using Cocoa. STATUS: IN PROGRESS
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
14 --> Locate (once more) the API documentation for shaped windows under Cocoa. STATUS: NEARLY FINISHED.
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
15 --> Design and encode a version of SDL_ShapeData for Cocoa. STATUS: IN PROGRESS.
4811
d79939f20c45 Working on Cocoa implementation.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4810
diff changeset
16 --> Write Cocoa_CreateShaper(). STATUS: MOSTLY DONE, AFAIK.
d79939f20c45 Working on Cocoa implementation.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4810
diff changeset
17 --> Write Cocoa_ResizeWindowShape(). STATUS: DONE, AFAIK.
4810
7a602fd2121f OK, it appears that dramatic hacks are not necessary to make Cocoa work...
Eli Gottlieb <eligottlieb@gmail.com>
parents: 4788
diff changeset
18 --> Write Cocoa_SetWindowShape(). STATUS: IN PROGRESS.
4788
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
19 --> If necessary, implement functionality adjunct to SDL_CalculateShapeBitmap() for Cocoa usage.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
20 5. Use testeyes to debug all implementations. STATUS: SPRINT + 2.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
21 --> Debug Cocoa implementation.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
22 --> Debug Win32 implementation.
0bfda420c936 Put in a couple of fixes that I realized hadn't gotten done when I wrote out the SCRUM stuff in TODO. Added SCRUM listings in TODO.
Eli Gottlieb <eligottlieb@gmail.com>
parents: 3702
diff changeset
23 --> Debug X11 implementation (again).
2777
6f260584df22 Adding SDL 1.3 release checklist, so we start getting a list of must-have features and bug fixes for a 1.3 release
Sam Lantinga <slouken@libsdl.org>
parents: 2330
diff changeset
24
6f260584df22 Adding SDL 1.3 release checklist, so we start getting a list of must-have features and bug fixes for a 1.3 release
Sam Lantinga <slouken@libsdl.org>
parents: 2330
diff changeset
25 1.3 release checklist:
3702
6604099437ac Migrated most of the TODO list to the SDL 1.3 Roadmap wiki
Sam Lantinga <slouken@libsdl.org>
parents: 3690
diff changeset
26 * http://wiki.libsdl.org/moin.cgi/Roadmap
3563
d3a8bb6a37c1 Added notes from e-mail on desktop window implementation
Sam Lantinga <slouken@libsdl.org>
parents: 3562
diff changeset
27
3544
71189305cd33 minor notes to self
Sam Lantinga <slouken@libsdl.org>
parents: 3350
diff changeset
28 * See why windows are being rearranged. Is the shield window not up?
71189305cd33 minor notes to self
Sam Lantinga <slouken@libsdl.org>
parents: 3350
diff changeset
29 * Make sure you can create and show a fullscreen window in one step
71189305cd33 minor notes to self
Sam Lantinga <slouken@libsdl.org>
parents: 3350
diff changeset
30 * Figure out how to handle OpenGL context lost on Mac OS X (does it happen?)
3562
59ab35254459 Need to test the multi-draw APIs
Sam Lantinga <slouken@libsdl.org>
parents: 3544
diff changeset
31 * Write automated test case for multi-draw APIs
3595
b7c6828d4039 Make it possible to slim SDL down quite a bit for people who just want OpenGL
Sam Lantinga <slouken@libsdl.org>
parents: 3563
diff changeset
32 * Make sure you can build SDL without the renderer to slim it down a bunch
3690
e431b888ac6c Fixed compilation on iPhone
Sam Lantinga <slouken@libsdl.org>
parents: 3632
diff changeset
33 * Implement assertion code on iPhone
e431b888ac6c Fixed compilation on iPhone
Sam Lantinga <slouken@libsdl.org>
parents: 3632
diff changeset
34 * Add __WINDOWS__ in addition to __WIN32__
3544
71189305cd33 minor notes to self
Sam Lantinga <slouken@libsdl.org>
parents: 3350
diff changeset
35
3632
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
36 * Check 1.2 revisions:
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
37 3554 - Need to resolve semantics for locking keys on different platforms
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
38 4874 - Do we want screen rotation? At what level?
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
39 4974 - Windows file code needs to convert UTF-8 to Unicode, but we don't need to tap dance for Windows 95/98
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
40 4484, 4485 - Verify that SDL's Windows keyboard handling works correctly
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
41 4865 - See if this is still needed (mouse coordinate clamping)
da2a23b56493 Updated 1.2 revisions that need to be revisited
Sam Lantinga <slouken@libsdl.org>
parents: 3595
diff changeset
42 4866 - See if this is still needed (blocking window repositioning)