Browse Source

include: Documented SDL_bool a little.

Ryan C. Gordon 1 year ago
parent
commit
e47f2956cf
1 changed files with 22 additions and 1 deletions
  1. 22 1
      include/SDL3/SDL_stdinc.h

+ 22 - 1
include/SDL3/SDL_stdinc.h

@@ -136,10 +136,31 @@ void *alloca(size_t);
 /* @{ */
 
 /**
- * A boolean type.
+ * A boolean false.
+ *
+ * \since This macro is available since SDL 3.0.0.
+ *
+ * \sa SDL_bool
  */
 #define SDL_FALSE 0
+
+/**
+ * A boolean true.
+ *
+ * \since This macro is available since SDL 3.0.0.
+ *
+ * \sa SDL_bool
+ */
 #define SDL_TRUE 1
+
+/**
+ * A boolean type: true or false.
+ *
+ * \since This datatype is available since SDL 3.0.0.
+ *
+ * \sa SDL_TRUE
+ * \sa SDL_FALSE
+ */
 typedef int SDL_bool;
 
 /**