From 25e2b1f7f7260057e05ce9f6853e90ada5e63ed1 Mon Sep 17 00:00:00 2001 From: Philipp Zander Date: Mon, 3 Jun 2024 02:11:06 +0200 Subject: [PATCH] improve note in `nix_value_force` documentation --- src/libexpr-c/nix_api_expr.h | 6 ++---- src/libexpr-c/nix_api_value.h | 3 ++- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/libexpr-c/nix_api_expr.h b/src/libexpr-c/nix_api_expr.h index b026ea70b..0d324b148 100644 --- a/src/libexpr-c/nix_api_expr.h +++ b/src/libexpr-c/nix_api_expr.h @@ -129,10 +129,8 @@ nix_err nix_value_call_multi( * * This function converts these Values into their final type. * - * @note You don't need this function for basic API usage, since all functions - * that return a value call it for you. The only place you will see a - * NIX_TYPE_THUNK is in the arguments that are passed to a PrimOp function - * you supplied to nix_alloc_primop. + * @note You don't need this function for basic API usage very often, since all functions that return a `Value` call it + * for you. This function is mainly needed before calling @ref getters. * * @param[out] context Optional, stores error information * @param[in] state The state of the evaluation. diff --git a/src/libexpr-c/nix_api_value.h b/src/libexpr-c/nix_api_value.h index f568b5c27..244860707 100644 --- a/src/libexpr-c/nix_api_value.h +++ b/src/libexpr-c/nix_api_value.h @@ -148,7 +148,8 @@ Value * nix_alloc_value(nix_c_context * context, EvalState * state); * @brief Functions to inspect and change Nix language values, represented by Value. * @{ */ -/** @name Getters +/** @anchor getters + * @name Getters */ /**@{*/ /** @brief Get value type