From ec9cf4ef9b4ff2a16172e72adf5fca2a94ba3009 Mon Sep 17 00:00:00 2001 From: pommicket Date: Thu, 11 Sep 2025 16:40:04 -0400 Subject: Start libpom implementation --- pom.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'pom.h') 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 * -- cgit v1.2.3