summaryrefslogtreecommitdiff
path: root/pom.h
diff options
context:
space:
mode:
Diffstat (limited to 'pom.h')
-rw-r--r--pom.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/pom.h b/pom.h
index 1cad0ca..f76c30d 100644
--- a/pom.h
+++ b/pom.h
@@ -111,12 +111,13 @@ pom_load(const char *filename,
POM__MUST_USE_R;
#ifndef POM_NO_STDIO
-/// Load configuration from a `FILE *`.
+/// Load configuration from a `FILE *`, which should be opened in binary mode.
///
/// On success, a configuration is returned and `*error` is set to `NULL`
/// if `error` is not `NULL`.
///
-/// On failure, `NULL` is returned, and `*error` is filled out if `error` is not `NULL`,
+/// On failure, `NULL` is returned, and `*error` is filled out if `error` is not `NULL`
+/// (or set to `NULL` if no memory is available),
/// in which case it must be freed with `free`.
///
/// `filename` is only used for errors.
@@ -130,7 +131,8 @@ POM__MUST_USE_R;
/// On success, a configuration is returned and `*error` is set to `NULL`
/// if `error` is not `NULL`.
///
-/// On failure, `NULL` is returned, and `*error` is filled out if `error` is not `NULL`,
+/// On failure, `NULL` is returned, and `*error` is filled out if `error` is not `NULL`
+/// (or set to `NULL` if no memory is available),
/// in which case it must be freed with `free`.
POM__MUST_USE_L
pom_conf *