mirror of
https://github.com/encounter/dawn-cmake.git
synced 2025-12-18 01:15:39 +00:00
Fixup all doxygen tags
We've been using |blah| in various places to markup code, however this is not doxygen markup. So instead: * If the code links to a parameter, use `blah`. * If the code links to a member field, use #blah. * If the code links to a method use blah(). * If the code is somewhere unlinkable use `blah`. Change-Id: Idac748a4c2531b5bae77e1a335e3d3ef6fab48b6 Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/33787 Commit-Queue: dan sinclair <dsinclair@chromium.org> Reviewed-by: dan sinclair <dsinclair@chromium.org> Reviewed-by: David Neto <dneto@google.com>
This commit is contained in:
committed by
Commit Bot service account
parent
f7e3bfc1a5
commit
f8971ae74d
@@ -28,7 +28,7 @@ namespace diag {
|
||||
/// Severity is an enumerator of diagnostic severities.
|
||||
enum class Severity { Info, Warning, Error, Fatal };
|
||||
|
||||
/// @return true iff |a| is more than, or of equal severity to |b|.
|
||||
/// @return true iff `a` is more than, or of equal severity to `b`
|
||||
inline bool operator>=(Severity a, Severity b) {
|
||||
return static_cast<int>(a) >= static_cast<int>(b);
|
||||
}
|
||||
@@ -57,25 +57,25 @@ class List {
|
||||
/// Constructs the list with no elements.
|
||||
List();
|
||||
|
||||
/// Copy constructor. Copies the diagnostics from |list| into this list.
|
||||
/// Copy constructor. Copies the diagnostics from `list` into this list.
|
||||
/// @param list the list of diagnostics to copy into this list.
|
||||
List(std::initializer_list<Diagnostic> list);
|
||||
|
||||
/// Copy constructor. Copies the diagnostics from |list| into this list.
|
||||
/// Copy constructor. Copies the diagnostics from `list` into this list.
|
||||
/// @param list the list of diagnostics to copy into this list.
|
||||
List(const List& list);
|
||||
|
||||
/// Move constructor. Moves the diagnostics from |list| into this list.
|
||||
/// Move constructor. Moves the diagnostics from `list` into this list.
|
||||
/// @param list the list of diagnostics to move into this list.
|
||||
List(List&& list);
|
||||
~List();
|
||||
|
||||
/// Assignment operator. Copies the diagnostics from |list| into this list.
|
||||
/// Assignment operator. Copies the diagnostics from `list` into this list.
|
||||
/// @param list the list to copy into this list.
|
||||
/// @return this list.
|
||||
List& operator=(const List& list);
|
||||
|
||||
/// Assignment move operator. Moves the diagnostics from |list| into this
|
||||
/// Assignment move operator. Moves the diagnostics from `list` into this
|
||||
/// list.
|
||||
/// @param list the list to move into this list.
|
||||
/// @return this list.
|
||||
|
||||
@@ -91,9 +91,9 @@ struct Formatter::State {
|
||||
/// newline queues a newline to be written to the printer.
|
||||
void newline() { stream << std::endl; }
|
||||
|
||||
/// repeat queues the character c to be writen to the printer n times.
|
||||
/// @param c the character to print |n| times
|
||||
/// @param n the number of times to print character |c|
|
||||
/// repeat queues the character c to be written to the printer n times.
|
||||
/// @param c the character to print `n` times
|
||||
/// @param n the number of times to print character `c`
|
||||
void repeat(char c, size_t n) {
|
||||
while (n-- > 0) {
|
||||
stream << c;
|
||||
|
||||
@@ -51,7 +51,7 @@ class Formatter {
|
||||
/// @param printer the printer used to display the formatted diagnostics
|
||||
void format(const List& list, Printer* printer) const;
|
||||
|
||||
/// @return the list of diagnostics |list| formatted to a string.
|
||||
/// @return the list of diagnostics `list` formatted to a string.
|
||||
/// @param list the list of diagnostic messages to format
|
||||
std::string format(const List& list) const;
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ class Printer {
|
||||
public:
|
||||
/// @returns a diagnostic Printer
|
||||
/// @param out the file to print to.
|
||||
/// @param use_colors if true, the printer will use colors if |out| is a
|
||||
/// @param use_colors if true, the printer will use colors if `out` is a
|
||||
/// terminal and supports them.
|
||||
static std::unique_ptr<Printer> create(FILE* out, bool use_colors);
|
||||
|
||||
@@ -58,7 +58,7 @@ class Printer {
|
||||
|
||||
/// writes the string str to the printer with the given style.
|
||||
/// @param str the string to write to the printer
|
||||
/// @param style the style used to print |str|
|
||||
/// @param style the style used to print `str`
|
||||
virtual void write(const std::string& str, const Style& style) = 0;
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user