From 2bd66922eef1c41e74efe1cca722b0ee7d640af1 Mon Sep 17 00:00:00 2001 From: Philipp Date: Wed, 29 May 2024 01:05:40 +0200 Subject: [PATCH] add empty line to documentation comments after `@brief` field (#10800) * add empty line to documentation comments after `@brief` field Co-authored-by: Cole Helbling --- src/libexpr-c/nix_api_value.h | 1 + src/libstore-c/nix_api_store.h | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/libexpr-c/nix_api_value.h b/src/libexpr-c/nix_api_value.h index b2b3439ef..f568b5c27 100644 --- a/src/libexpr-c/nix_api_value.h +++ b/src/libexpr-c/nix_api_value.h @@ -79,6 +79,7 @@ typedef struct nix_realised_string nix_realised_string; * @{ */ /** @brief Function pointer for primops + * * When you want to return an error, call nix_set_err_msg(context, NIX_ERR_UNKNOWN, "your error message here"). * * @param[in] user_data Arbitrary data that was initially supplied to nix_alloc_primop diff --git a/src/libstore-c/nix_api_store.h b/src/libstore-c/nix_api_store.h index e9441be1a..d3cb8fab8 100644 --- a/src/libstore-c/nix_api_store.h +++ b/src/libstore-c/nix_api_store.h @@ -54,8 +54,10 @@ nix_err nix_libstore_init_no_load_config(nix_c_context * context); nix_err nix_init_plugins(nix_c_context * context); /** - * @brief Open a nix store + * @brief Open a nix store. + * * Store instances may share state and resources behind the scenes. + * * @param[out] context Optional, stores error information * @param[in] uri URI of the Nix store, copied. See [*Store URL format* in the Nix Reference * Manual](https://nixos.org/manual/nix/stable/store/types/#store-url-format). @@ -157,7 +159,9 @@ nix_err nix_store_realise( /** * @brief get the version of a nix store. + * * If the store doesn't have a version (like the dummy store), returns an empty string. + * * @param[out] context Optional, stores error information * @param[in] store nix store reference * @param[in] callback Called with the version.