diff options
| author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-03-26 21:12:25 -0400 |
|---|---|---|
| committer | John Ericson <John.Ericson@Obsidian.Systems> | 2023-03-31 23:01:40 -0400 |
| commit | abd5e7dec039386628223f886b33047734172c8d (patch) | |
| tree | ca3aecd64e1e9375ab6ed48d4a7dc54ac83b584d /src/libutil/suggestions.hh | |
| parent | 8ae9d669409851acb6de39335b11a95a991eae6d (diff) | |
Extend internal API docs, part 2
Picking up from #8111.
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
Diffstat (limited to 'src/libutil/suggestions.hh')
| -rw-r--r-- | src/libutil/suggestions.hh | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/libutil/suggestions.hh b/src/libutil/suggestions.hh index d54dd8e31..0a7560aff 100644 --- a/src/libutil/suggestions.hh +++ b/src/libutil/suggestions.hh @@ -13,7 +13,8 @@ int levenshteinDistance(std::string_view first, std::string_view second); */ class Suggestion { public: - int distance; // The smaller the better + /// The smaller the better + int distance; std::string suggestion; std::string to_string() const; @@ -43,7 +44,9 @@ public: std::ostream & operator<<(std::ostream & str, const Suggestion &); std::ostream & operator<<(std::ostream & str, const Suggestions &); -// Either a value of type `T`, or some suggestions +/** + * Either a value of type `T`, or some suggestions + */ template<typename T> class OrSuggestions { public: |