1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-15 23:12:44 +01:00

EvalState: add doc comment

This commit is contained in:
Robert Hensing 2025-10-13 13:14:05 +02:00
parent 6db86389ce
commit 48a5e2dde2
2 changed files with 15 additions and 4 deletions

View file

@ -193,7 +193,9 @@ public:
}
/**
* @param pos Nullable `shared_ptr<Pos>`
* Prepends an item to the error trace, as is usual for extra context.
*
* @param pos Nullable source position to put in trace item
* @param fs Format string, see `HintFmt`
* @param args... Format string arguments.
*/
@ -204,9 +206,11 @@ public:
}
/**
* @param pos Nullable `shared_ptr<Pos>`
* Prepends an item to the error trace, as is usual for extra context.
*
* @param pos Nullable source position to put in trace item
* @param hint Formatted error message
* @param print Optional, whether to always print (e.g. `addErrorContext`)
* @param print Optional, whether to always print (used by `addErrorContext`)
*/
void addTrace(std::shared_ptr<const Pos> && pos, HintFmt hint, TracePrint print = TracePrint::Default);