v9.2

Author: nichcode

include/pal/pal_core.h

@@ -216,6 +216,7 @@ typedef void(PAL_CALL* PalLogCallback)(
 /**
  * @enum PalResult
  * @brief Codes returned by most PAL functions to specify success or failure.
+ * This is not a bitmask.
  *
  * `PAL_RESULT_SUCCESS` code means the operation completed successfully. Any
  * other value indicates an error.
@@ -374,7 +375,7 @@ typedef struct {
  *
  * @return A copy of PAL runtime version.
  *
- * @note This function is thread-safe
+ * @note This function is thread-safe and may be called from any thread.
  *
  * @sa palGetVersionString()
  * @sa PalVersion
@@ -637,7 +638,8 @@ static inline void PAL_CALL palUnpackUint32(
  * @param[out] outLow Low value of the 64-bit signed integer.
  * @param[out] outHigh High value of the 64-bit signed integer.
  *
- * @note This function is thread-safe if `outLow` and `outHigh` are thread local.
+ * @note This function is thread-safe if `outLow` and `outHigh` are thread
+ * local.
  *
  * @sa palUnpackInt32()
  * @sa palPackUint32()

include/pal/pal_event.h

@@ -284,7 +284,7 @@ typedef struct {
 } PalEventDriverCreateInfo;
 
 /**
- * @brief Creates an event driver with an event driver create info.
+ * @brief Creates an event driver.
  *
  * An event driver is used to signal events between multiple systems.
  * It it used to shared information from one system or entity to another.
@@ -296,15 +296,8 @@ typedef struct {
  * @param[out] outEventDriver Pointer to a PalEventDriver to recieve the created
  * event driver.
  *
- * @return
- * - `PAL_RESULT_SUCCESS` on success.
- *
- * - `PAL_RESULT_NULL_POINTER` if `info` or `outEventDriver` is nullptr.
- *
- * - `PAL_RESULT_OUT_MEMORY` if there is not enough memory.
- *
- * - `PAL_RESULT_INVALID_ALLOCATOR` if the allocator's function pointers are not
- * fully set.
+ * @return `PAL_RESULT_SUCCESS` on success or an appropriate result code on
+ * failure. Call palFormatResult() for more information.
  *
  * @note This function may be called from any thread, but not concurrently.
  * Users must ensure synchronization.