Mercurial > sdl-ios-xcode
comparison include/SDL_events.h @ 4635:0a07d002f10b
Fixed documentation error
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 14 Aug 2010 12:28:43 -0700 |
parents | 95352c671a6e |
children | c24ba2cc9583 |
comparison
equal
deleted
inserted
replaced
4634:242c805baf68 | 4635:0a07d002f10b |
---|---|
380 * | 380 * |
381 * If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to | 381 * If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to |
382 * the back of the event queue. | 382 * the back of the event queue. |
383 * | 383 * |
384 * If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front | 384 * If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front |
385 * of the event queue, matching \c mask, will be returned and will not | 385 * of the event queue, within the specified minimum and maximum type, |
386 * be removed from the queue. | 386 * will be returned and will not be removed from the queue. |
387 * | 387 * |
388 * If \c action is ::SDL_GETEVENT, up to \c numevents events at the front | 388 * If \c action is ::SDL_GETEVENT, up to \c numevents events at the front |
389 * of the event queue, matching \c mask, will be returned and will be | 389 * of the event queue, within the specified minimum and maximum type, |
390 * removed from the queue. | 390 * will be returned and will be removed from the queue. |
391 * | 391 * |
392 * \return The number of events actually stored, or -1 if there was an error. | 392 * \return The number of events actually stored, or -1 if there was an error. |
393 * | 393 * |
394 * This function is thread-safe. | 394 * This function is thread-safe. |
395 */ | 395 */ |