eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-07 07:50:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve log documentation

Browse source
This commit is contained in:
nightmareci 2025-01-22 10:22:42 -08:00 • committed by Sam Lantinga
parent 1c21a72bda
commit a437dbc7e3
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/SDL3/SDL_log.h
View file

@ -56,6 +56,15 @@
* - Windows: debug output stream * - Windows: debug output stream
* - Android: log output * - Android: log output
* - Others: standard error output (stderr) * - Others: standard error output (stderr)
*
* You don't need to have a newline (`\n`) on the end of messages, the
* functions will do that for you. For consistent behavior cross-platform, you
* shouldn't have any newlines in messages, such as to log multiple lines in
* one call; unusual platform-specific behavior can be observed in such usage.
* Do one log call per line instead, with no newlines in messages.
*
* Each log call is atomic, so you won't see log messages cut off one another
* when logging from multiple threads.
*/ */
#ifndef SDL_log_h_ #ifndef SDL_log_h_