[This should go on the documentation list but I’m not a member yet,
perhaps someone can cross post for me?]On 12/06/2013, at 1:25 PM, Sam Lantinga wrote:
No, it’s hand-written.
On Tue, Jun 11, 2013 at 2:10 PM, john skaller <@john_skaller> wrote:
I’m curious because it looks generated rather than hand written,
judging by the header file.
I’ve been comparing my tarball headers (mainly SDL_event.h) with the
Wiki docs and the Wiki is WAY out!
For example it seems these are documented:
// Tablet or multiple mice input
but don’t exist. And these exist but aren’t documented:
/* Game controller events */
SDL_CONTROLLERAXISMOTION = 0x650, /**< Game controller axis motion */
SDL_CONTROLLERBUTTONDOWN, /**< Game controller button pressed */
SDL_CONTROLLERBUTTONUP, /**< Game controller button released */
SDL_CONTROLLERDEVICEADDED, /**< A new Game controller has been inserted into the system */
SDL_CONTROLLERDEVICEREMOVED, /**< An opened Game controller has been removed */
SDL_CONTROLLERDEVICEREMAPPED, /**< The controller mapping was updated */
It looks like the source code is Doxygen commented.
IMHO a Wiki is a good way to add notes, examples, etc to official docs,
but it’s a horrible way to provide core documentation. There’s more work
keeping it right than developing the source code
Of course the “right” way is to write the specs and make the code
implement them …
[Actually there is technology that does all this stuff properly,
namely literate programming. But it isn’t popular, perhaps because
it doesn’t play well with existing IDE’s]