diff options
Diffstat (limited to 'pom.h')
| -rw-r--r-- | pom.h | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -10,8 +10,9 @@ /// provided that C11 atomics are available /// (`__STDC_VERSION__ >= 201112L && !defined(__STDC_NO_ATOMICS__)`). /// But beware of race conditions when using \ref pom_conf_next_unread_key -/// (ensure there is synchronization so that all threads -/// have certainly read their keys before calling it). +/// — this will not lead to UB but you may get unexpected results — +/// ensure there is synchronization so that all threads +/// have certainly read their keys before calling it. /// /// If C11 atomics are not available, you can almost certainly still get away /// with sharing configurations across threads, as long as you use proper @@ -203,7 +204,7 @@ pom_error_print(const pom_error *error); /// Includes every error in an error list (see \ref pom_error_next). POM__MUST_USE_L char * -pom_error_to_string(const pom_error *error) +pom_error_to_string(pom_error *error) POM__MUST_USE_R; /// Returns `true` if `key` is present in `conf`, `false` otherwise. @@ -409,7 +410,7 @@ pom_conf_next_item(const pom_conf *conf, pom_item_iter **iter); /// /// The copy must be freed with \ref pom_conf_free. /// -/// Returns `NULL` (but does not set `conf`'s error) in the (rare) case of out-of-memory. +/// Returns `NULL` on out-of-memory. /// /// The copy is entirely independent from `conf` — it can be passed to a separate /// thread without worry. |