Missing a star for Doxygen in SDL 1.3 (minor)

2009/10/4 Kenneth Bull <@Kenneth_Bull>:

2009/10/4 E. Wing :

Hi Kenneth,
I noticed that SDL_SetColorKey and SDL_GetColorKey start with
/*
instead of
/**
in SDL_Surface.h in SDL 1.3.

I’ve only really worked on adding doxygen support to SDL 1.2 and those
changes haven’t found their way into 1.3 yet.

Most new features in SDL 1.3 are documented (though they still need
some work) since Sam has been taking care of that himself with new
code. ?Most code brought over from 1.2 is still not documented for
doxygen.

I’ll touch it up and submit a patch later though.

I haven’t scrutinized the headers and I don’t know if you had an
automated process to add these, but I thought I would let you know in
case there might be others that have the same problem.

No automation, just going through the headers line by line…

FYI, if you missed my announcement, I am trying to leverage your
Doxygen work to generate Xcode DocSets for SDL for better Xcode
integration.

I don’t have a Mac, so I’m not really familiar with XCode. ?I probably
won’t be able to help you with this much.

Thanks,
Eric

Here’s the patch. This only covers SDL_surface.h for SDL 1.3. I
still haven’t checked the other headers yet.
I’ve submitted a bug report with this same patch (Bug 826
http://bugzilla.libsdl.org/show_bug.cgi?id=826 ).
-------------- next part --------------
A non-text attachment was scrubbed…
Name: sdl_1.3_surface_h_doxygen.diff
Type: application/octet-stream
Size: 13891 bytes
Desc: not available
URL: http://lists.libsdl.org/pipermail/sdl-libsdl.org/attachments/20091004/2791d730/attachment.obj

Thanks!On Sun, Oct 4, 2009 at 9:55 AM, Kenneth Bull wrote:

2009/10/4 Kenneth Bull :

2009/10/4 E. Wing :

Hi Kenneth,
I noticed that SDL_SetColorKey and SDL_GetColorKey start with
/*
instead of
/**
in SDL_Surface.h in SDL 1.3.

I’ve only really worked on adding doxygen support to SDL 1.2 and those
changes haven’t found their way into 1.3 yet.

Most new features in SDL 1.3 are documented (though they still need
some work) since Sam has been taking care of that himself with new
code. ?Most code brought over from 1.2 is still not documented for
doxygen.

I’ll touch it up and submit a patch later though.

I haven’t scrutinized the headers and I don’t know if you had an
automated process to add these, but I thought I would let you know in
case there might be others that have the same problem.

No automation, just going through the headers line by line…

FYI, if you missed my announcement, I am trying to leverage your
Doxygen work to generate Xcode DocSets for SDL for better Xcode
integration.

I don’t have a Mac, so I’m not really familiar with XCode. ?I probably
won’t be able to help you with this much.

Thanks,
Eric

Here’s the patch. ?This only covers SDL_surface.h for SDL 1.3. ?I
still haven’t checked the other headers yet.
I’ve submitted a bug report with this same patch (Bug 826
http://bugzilla.libsdl.org/show_bug.cgi?id=826 ).


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