This bug report was migrated from our old Bugzilla tracker.

These attachments are available in the static archive:

• Adds Doxygen support for all headers (except config and boilerplate headers) in the include folder for SDL-1.2 revision 4446. (doc.diff, text/plain, 2009-02-25 13:22:02 +0000, 149915 bytes)
• Doxyfile for SDL 1.2 (Doxyfile, text/plain, 2009-03-01 22:11:52 +0000, 37209 bytes)

Reported in version: HG 1.2
Reported for operating system, platform: All, All

Comments on the original bug report:

On 2009-02-25 13:22:02 +0000, Ken Bull wrote:

Created attachment 301
Adds Doxygen support for all headers (except config and boilerplate headers) in the include folder for SDL-1.2 revision 4446.

While in general SDL is quite thoroughly commented, none of these comments are correctly formatted for Doxygen and are generally inconsistent in their formatting.

On 2009-03-01 22:11:52 +0000, Ryan C. Gordon wrote:

Created attachment 303
Doxyfile for SDL 1.2

Here's a Doxyfile to go with the patch. This may not be perfect, it was just a cut-and-paste from the SDL_sound project.

Install Doxygen, put this in SDL-1.2's base directory and run "doxygen" with no arguments ... then you'll get a "doxygen" directory with HTML, .rtf, and manpages.

--ryan.

On 2009-03-01 22:14:41 +0000, Ryan C. Gordon wrote:

Tossing this bug to Sam. Keeping the headers Doxygen-friendly is a really good idea, even with an external documentation wiki.

This will probably need to be tweaked to your liking, and eventually, someone will have to do this for the 1.3 branch (but we'll call that a separate bug, if this one works out as an experiment with 1.2).

--ryan.

On 2009-09-13 16:33:21 +0000, Ryan C. Gordon wrote:

Tagging this bug with "target-1.2.14" so we can try to resolve it for SDL 1.2.14.

Please note that we may choose to resolve it as WONTFIX. This tag is largely so we have a comprehensive wishlist of bugs to examine for 1.2.14 (and so we can close bugs that we'll never fix, rather than have them live forever in Bugzilla).

--ryan.

On 2009-09-21 02:39:27 +0000, Sam Lantinga wrote:

Wow, this is awesome. I've tried to start adding doxygen support to SDL 1.3, but I don't have as much experience with it as you have. Would you mind going through and checking the SDL 1.3 headers to see where they can be improved?

Thanks!