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 270

Summary: SDLSETCURSOR.HTML Wrong Return Type
Product: SDL Reporter: Victor Wheeler <vaw_junk998>
Component: *don't know*Assignee: Sam Lantinga <slouken>
Status: RESOLVED FIXED QA Contact: Sam Lantinga <slouken>
Severity: normal    
Priority: P2 CC: vaw_junk998
Version: 1.2.9   
Hardware: x86   
OS: Windows (XP)   

Description Victor Wheeler 2006-07-02 00:26:30 UTC
Gentlemen:

I have SDL 1.2.9 with a .\docs\html\ subdirectory with file sdlsetcursor.html.

This same text also appears in a compiled HTML help file SDLRef.chm, so I suspect this one source file (sdlsetcursor.html) is probably source to a variety of help documentation.

In any case, the SDL_SetCursor function is shown there to have a return type of a void pointer (void *).  However, in the SDL_mouse.h file, it is prototyped as having a return type of simply void.  Specifically shown in documentation:

    "Synopsis

    "#include "SDL.h"
    "void *SDL_SetCursor(SDL_Cursor *cursor);

    "Description
    "..."

The SDL_mouse.H file lists it like this:

    extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor *cursor);

in other words

    void SDL_SetCursor(SDL_Cursor *cursor);

I have to give credit to the Eiffel compiler for catching this difference after I had programmed it as having a (void *) return type.

Sugg:

If, indeed, it should be a void return type, I suggest correcting the source HTML file and update the various locations where it is stored or compiled into (e.g. SDLRef.chm).

Thanks very much for writing/supporting this library.  It's awesome!

Kind regards,
Vic Wheeler
Comment 1 Ryan C. Gordon 2006-07-02 07:34:15 UTC
Tossing to Sam...it looks like these files were generated via DocBook, but I don't see the original .xml file they would be generated from. Are we just editing these by hand now?

--ryan.

Comment 2 Sam Lantinga 2006-09-23 20:36:09 UTC
Fixed in subversion, thanks!