diff options
author | Chad Versace <chad.versace@linux.intel.com> | 2012-08-19 21:14:39 -0700 |
---|---|---|
committer | Chad Versace <chad.versace@linux.intel.com> | 2012-08-19 21:15:37 -0700 |
commit | 6a1cf7411b3c9a0b6dbba89cde78a42f1507a787 (patch) | |
tree | 582a7397b1da91ba6985dd49a88ca968f69ba3ce /include | |
parent | 76e67a53bfd7215836a341e0c211561c7a41635e (diff) |
include: Cleanup waffle_error doxygen
- Remove redundant comments in waffle_error_get_code().
- Remove references to non-existent function, waffle_finish().
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'include')
-rw-r--r-- | include/waffle/waffle_error.h | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/include/waffle/waffle_error.h b/include/waffle/waffle_error.h index 3b76211..96e8272 100644 --- a/include/waffle/waffle_error.h +++ b/include/waffle/waffle_error.h @@ -66,9 +66,6 @@ struct waffle_error_info { /// @brief Get the current thread's error code. /// -/// This may be called when waffle is uninitialized (that is, before -/// waffle_init() and after waffle_finish()). -/// /// Calling this function is equivalent to obtaining the error code with /// `waffle_error_get_info()->code`. /// @@ -80,8 +77,8 @@ waffle_error_get_code(void); /// This function never returns null. The returned pointer becomes invalid /// when the thread-local error state changes. /// -/// This may be called when waffle is uninitialized (that is, before -/// waffle_init() and after waffle_finish()). +/// This may be called when waffle is uninitialized [that is, before +/// waffle_init()]. WAFFLE_API const struct waffle_error_info* waffle_error_get_info(void); |