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/libutil/ansicolor.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/libutil/ansicolor.hh')
| -rw-r--r-- | src/libutil/ansicolor.hh | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/libutil/ansicolor.hh b/src/libutil/ansicolor.hh index 54721649c..86becafa6 100644 --- a/src/libutil/ansicolor.hh +++ b/src/libutil/ansicolor.hh @@ -1,9 +1,12 @@ #pragma once -///@file +/** + * @file + * + * @brief Some ANSI escape sequences. + */ namespace nix { -/* Some ANSI escape sequences. */ #define ANSI_NORMAL "\e[0m" #define ANSI_BOLD "\e[1m" #define ANSI_FAINT "\e[2m" |