diff options
author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-04-07 09:55:28 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-07 13:55:28 +0000 |
commit | 0746951be1563b1dd590690f9ee48a2fe964bd93 (patch) | |
tree | 37d8bbba31ab63439eb1eab2a6b82654ff7535b8 /src/libexpr/attr-path.hh | |
parent | 54b3b6ebc638b148a8804b81e9c17ab52cddf8e1 (diff) |
Finish converting existing comments for internal API docs (#8146)
* Finish converting existing comments for internal API docs
99% of this was just reformatting existing comments. Only two exceptions:
- Expanded upon `BuildResult::status` compat note
- Split up file-level `symbol-table.hh` doc comments to get
per-definition docs
Also fixed a few whitespace goofs, turning leading tabs to spaces and
removing trailing spaces.
Picking up from #8133
* Fix two things from comments
* Use triple-backtick not indent for `dumpPath`
* Convert GNU-style `\`..'` quotes to markdown style in API docs
This will render correctly.
Diffstat (limited to 'src/libexpr/attr-path.hh')
-rw-r--r-- | src/libexpr/attr-path.hh | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/libexpr/attr-path.hh b/src/libexpr/attr-path.hh index d0d05b1a1..b2bfb5d04 100644 --- a/src/libexpr/attr-path.hh +++ b/src/libexpr/attr-path.hh @@ -17,7 +17,9 @@ std::pair<Value *, PosIdx> findAlongAttrPath( Bindings & autoArgs, Value & vIn); -/* Heuristic to find the filename and lineno or a nix value. */ +/** + * Heuristic to find the filename and lineno or a nix value. + */ std::pair<std::string, uint32_t> findPackageFilename(EvalState & state, Value & v, std::string what); std::vector<Symbol> parseAttrPath(EvalState & state, std::string_view s); |