mirror of
https://github.com/NixOS/nix.git
synced 2025-11-10 12:36:01 +01:00
doc: Improve libexpr-c docs
- Uses the more explicit `@ingroup` most of the time, to avoid problems with nested groups, and to make group membership more explicit. The division into headers is not great for documentation purposes, so this helps. - More attention for memory management details - Various other improvements to doc comments
This commit is contained in:
parent
1a4ad0706b
commit
5fc0c4f102
6 changed files with 237 additions and 78 deletions
|
|
@ -155,6 +155,8 @@ typedef struct nix_c_context nix_c_context;
|
|||
/**
|
||||
* @brief Called to get the value of a string owned by Nix.
|
||||
*
|
||||
* The `start` data is borrowed and the function must not assume that the buffer persists after it returns.
|
||||
*
|
||||
* @param[in] start the string to copy.
|
||||
* @param[in] n the string length.
|
||||
* @param[in] user_data optional, arbitrary data, passed to the nix_get_string_callback when it's called.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue