We are currently migrating Bugzilla to GitHub issues.
Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.
When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.

Bug 706 - SDL source code documentation does not work with doxygen
Summary: SDL source code documentation does not work with doxygen
Status: RESOLVED FIXED
Alias: None
Product: SDL
Classification: Unclassified
Component: *don't know* (show other bugs)
Version: HG 1.2
Hardware: All All
: P2 enhancement
Assignee: Sam Lantinga
QA Contact: Sam Lantinga
URL:
Keywords: target-1.2.14
Depends on:
Blocks:
 
Reported: 2009-02-25 13:22 UTC by Ken Bull
Modified: 2009-09-21 02:39 UTC (History)
1 user (show)

See Also:

Attachments
Adds Doxygen support for all headers (except config and boilerplate headers) in the include folder for SDL-1.2 revision 4446. (146.40 KB, patch)
2009-02-25 13:22 UTC, Ken Bull 		Details | Diff
Doxyfile for SDL 1.2 (36.34 KB, text/plain)
2009-03-01 22:11 UTC, Ryan C. Gordon 		Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Ken Bull 2009-02-25 13:22:02 UTC 
Created attachment 301 [details]
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.
Comment 1 Ryan C. Gordon 2009-03-01 22:11:52 UTC 
Created attachment 303 [details]
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.
Comment 2 Ryan C. Gordon 2009-03-01 22:14:41 UTC 
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.
Comment 3 Ryan C. Gordon 2009-09-13 16:33:21 UTC 
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.
Comment 4 Sam Lantinga 2009-09-21 02:39:27 UTC 
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!