This is the HTML Doxygen output for trunk/SDL revision 5123:
http://www.megaupload.com/?d=66TWXJK5
There have been no changes so far since 5123 which would affect the output.
This was compressed using 7zip in Ultra mode. It has a file size of
17.22 MB and a compression ratio of 0.59%. Big improvement over chm
and zip.
There is a tag file included to allow you to link to SDL documentation
from other projects using Doxygen.
This documentation was generated on Windows, with SDL and Doxygen
configured appropriately for that OS. This means that where a
function or structure differs from one platform to another, the
version use on Windows will be the one that appears most often in the
documentation. You won’t likely have any trouble using this on other
platforms though.
The Doxyfile, log and warnings are included with the documentation.
I’d recommend reviewing the doxygen_warn.txt file for documentation errors.
If you want to generate this stuff yourself, start with this Doxyfile.
Put it in the SDL/doxy folder. Modifying it for Unix is easy: just
change _WIN32 to unix and C:\Perl\bin\perl.exe to /usr/bin/perl.
Remember to change STRIP_FROM_PATH to wherever you put the SDL source
code and update PROJECT_NUMBER.
Sam, I’d suggest you use a script like this on some computer you don’t
need for anything else:
update thread:
clean up
run svn update in "SDL"
update "SDL/include/SDL_revision.h"
update “PROJECT_NUMBER” in "SDL/doxy/Doxyfile"
run doxygen in "SDL/doxy"
compress “SDL/doxy” folder
upload to website
main thread:
loop forever:
check for emails from SVN mailing list.
if new message:
if update thread active:
kill update thread
start update thread
Thanks!
There are still some files that haven’t been updated with the doxygen
format. Are you interested in doing a quick pass on them?
We’re currently working on the 1.3 wiki documentation that will have
more detailed documentation and examples, but having a quick API
reference from the headers is very helpful.
See ya!On Sat, Oct 17, 2009 at 8:12 PM, Kenneth Bull wrote:
This is the HTML Doxygen output for trunk/SDL revision 5123:
http://www.megaupload.com/?d=66TWXJK5
There have been no changes so far since 5123 which would affect the output.
This was compressed using 7zip in Ultra mode. ?It has a file size of
17.22 MB and a compression ratio of 0.59%. ?Big improvement over chm
and zip.
There is a tag file included to allow you to link to SDL documentation
from other projects using Doxygen.
This documentation was generated on Windows, with SDL and Doxygen
configured appropriately for that OS. ?This means that where a
function or structure differs from one platform to another, the
version use on Windows will be the one that appears most often in the
documentation. ?You won’t likely have any trouble using this on other
platforms though.
The Doxyfile, log and warnings are included with the documentation.
I’d recommend reviewing the doxygen_warn.txt file for documentation errors.
If you want to generate this stuff yourself, start with this Doxyfile.
Put it in the SDL/doxy folder. ?Modifying it for Unix is easy: ?just
change _WIN32 to unix and C:\Perl\bin\perl.exe to /usr/bin/perl.
Remember to change STRIP_FROM_PATH to wherever you put the SDL source
code and update PROJECT_NUMBER.
Sam, I’d suggest you use a script like this on some computer you don’t
need for anything else:
update thread:
?clean up
?run svn update in “SDL”
?update “SDL/include/SDL_revision.h”
?update “PROJECT_NUMBER” in “SDL/doxy/Doxyfile”
?run doxygen in “SDL/doxy”
?compress “SDL/doxy” folder
?upload to website
main thread:
?loop forever:
? check for emails from SVN mailing list.
? if new message:
? ? if update thread active:
? ? ? kill update thread
? ? start update thread
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
–
-Sam Lantinga, Founder and President, Galaxy Gameworks LLC
2009/10/17 Sam Lantinga :
Thanks!
There are still some files that haven’t been updated with the doxygen
format. ?Are you interested in doing a quick pass on them?
See bug 859 for a ridiculously large patch.
I posted an improved Doxyfile there too (SEPARATE_MEMBER_PAGES is
turned off though).
You can get the HTML output, tag file, warnings, log and Doxyfile here:
http://www.megaupload.com/?d=WKSP9DQU