commit 2d89d98fe1a8129522658f5a77cb1307673dc892
author Ben Clayton <bclayton@google.com> Mon Nov 02 18:02:18 2020 +0000
committer Commit Bot service account <commit-bot@chromium.org> Mon Nov 02 18:02:18 2020 +0000
tree 9b7154eb94cba069acd2e43340a555e6642b4055
parent cd5e4a80833c9822610bb60d8e05d0983ce44bb5

Fix all doxygen warnings

Bug: tint:282
Change-Id: I6c243c30f4477bb972dc737c8b3ff9cc2e0a91f2
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/31568
Reviewed-by: dan sinclair <dsinclair@chromium.org>
Commit-Queue: Ben Clayton <bclayton@google.com>

src/diagnostic/diagnostic.h

diff --git a/src/diagnostic/diagnostic.h b/src/diagnostic/diagnostic.h
index 843a006..98175fe 100644
--- a/src/diagnostic/diagnostic.h
+++ b/src/diagnostic/diagnostic.h
@@ -37,20 +37,31 @@
 /// message.
 class Diagnostic {
  public:
+  /// severity is the severity of the diagnostic message.
   Severity severity = Severity::Error;
+  /// source is the location of the diagnostic.
   Source source;
+  /// message is the text associated with the diagnostic.
   std::string message;
 };
 
 /// List is a container of Diagnostic messages.
 class List {
  public:
+  /// iterator is the type used for range based iteration.
   using iterator = std::vector<Diagnostic>::const_iterator;
 
+  /// Constructs the list with no elements.
   List();
+
+  /// Constructs the list with a copy of the diagnostics in |list|.
+  /// @param list the list of diagnostics to copy into this list.
   List(std::initializer_list<Diagnostic> list);
+
   ~List();
 
+  /// adds a diagnostic to the end of this list.
+  /// @param diag the diagnostic to append to this list.
   void add(Diagnostic&& diag) {
     entries_.emplace_back(std::move(diag));
     if (diag.severity >= Severity::Error) {

src/reader/wgsl/parser_impl.h

diff --git a/src/reader/wgsl/parser_impl.h b/src/reader/wgsl/parser_impl.h
index 8ea3e6c..9a902f4 100644
--- a/src/reader/wgsl/parser_impl.h
+++ b/src/reader/wgsl/parser_impl.h
@@ -81,9 +81,12 @@
   /// TypedIdentifier holds a parsed identifier and type. Returned by
   /// variable_ident_decl().
   struct TypedIdentifier {
-    ast::type::Type* type = nullptr;  /// Parsed type.
-    std::string name;                 /// Parsed identifier.
-    Source source;                    /// Source to the identifier.
+    /// Parsed type.
+    ast::type::Type* type = nullptr;
+    /// Parsed identifier.
+    std::string name;
+    /// Source to the identifier.
+    Source source;
   };
 
   /// Creates a new parser using the given file

src/source.h

diff --git a/src/source.h b/src/source.h
index ffc873b..e26c14a 100644
--- a/src/source.h
+++ b/src/source.h
@@ -44,12 +44,11 @@
   };
 
   /// Location holds a 1-based line and column index.
-  /// 0's for |line| or |column| represent invalid values.
   class Location {
    public:
-    /// The line number, 1-based
+    /// the 1-based line number. 0 represents no line information.
     size_t line = 0;
-    /// The column number, 1-based
+    /// the 1-based column number. 0 represents no column information.
     size_t column = 0;
   };
 
@@ -60,12 +59,12 @@
     inline Range() = default;
 
     /// Constructs a zero-length Range starting at |loc|.
-    /// @param loc the location to use to build the range
+    /// @param loc the start and end location for the range.
     inline explicit Range(const Location& loc) : begin(loc), end(loc) {}
 
     /// Constructs the Range beginning at |b| and ending at |e|.
-    /// @param b the beginning of the range
-    /// @param e the end of the range
+    /// @param b the range start location.
+    /// @param e the range end location.
     inline Range(const Location& b, const Location& e) : begin(b), end(e) {}
 
     /// The location of the first character in the range.
@@ -78,21 +77,21 @@
   inline Source() = default;
 
   /// Constructs the Source with the Range |rng| and a null File.
-  /// @param rng the range to assign to the source
+  /// @param rng the source range
   inline explicit Source(const Range& rng) : range(rng) {}
 
   /// Constructs the Source with the Range |loc| and a null File.
-  /// @param loc the location to assign to the source
+  /// @param loc the start and end location for the source range
   inline explicit Source(const Location& loc) : range(Range(loc)) {}
 
   /// Constructs the Source with the Range |rng| and File |f|.
-  /// @param rng the range for the source
-  /// @param f the file for the source
+  /// @param rng the source range
+  /// @param f the source file
   inline Source(const Range& rng, File const* f) : range(rng), file(f) {}
 
-  /// Line/column range for this source
+  /// range is the span of text this source refers to in |file|
   Range range;
-  /// Source file
+  /// file is the source file this source refers to
   File const* file = nullptr;
 };