NixOS/nix
NixOS/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2024-09-19 10:50:24 -04:00
Code Activity

add empty line to documentation comments after @brief field (#10800)

Browse source 
* add empty line to documentation comments after `@brief` field

Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
This commit is contained in:
Philipp 2024-05-29 01:05:40 +02:00 committed by GitHub
parent 1e2b26734b
commit 2bd66922ee
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/libexpr-c/nix_api_value.h
View file

@ -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

6
src/libstore-c/nix_api_store.h
View file

@ -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.