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>

src/ast/block_statement.h

@@ -62,18 +62,18 @@ class BlockStatement : public Castable<BlockStatement, Statement> {
     return statements_.empty() ? nullptr : statements_.back();
   }
 
-  /// Retrieves the statement at |idx|
+  /// Retrieves the statement at `idx`
   /// @param idx the index. The index is not bounds checked.
-  /// @returns the statement at |idx|
+  /// @returns the statement at `idx`
   const Statement* get(size_t idx) const { return statements_[idx]; }
 
-  /// Retrieves the statement at |idx|
+  /// Retrieves the statement at `idx`
   /// @param idx the index. The index is not bounds checked.
-  /// @returns the statement at |idx|
+  /// @returns the statement at `idx`
   Statement* operator[](size_t idx) { return statements_[idx]; }
-  /// Retrieves the statement at |idx|
+  /// Retrieves the statement at `idx`
   /// @param idx the index. The index is not bounds checked.
-  /// @returns the statement at |idx|
+  /// @returns the statement at `idx`
   const Statement* operator[](size_t idx) const { return statements_[idx]; }
 
   /// @returns the beginning iterator

src/ast/clone_context.h

@@ -34,8 +34,8 @@ class CloneContext {
   /// Destructor
   ~CloneContext();
 
-  /// Clones the `Node` or `type::Type` @p a into the module #mod if @p a is not
-  /// null. If @p a is null, then Clone() returns null. If @p a has been cloned
+  /// Clones the `Node` or `type::Type` `a` into the module #mod if `a` is not
+  /// null. If `a` is null, then Clone() returns null. If `a` has been cloned
   /// already by this CloneContext then the same cloned pointer is returned.
   /// @note Semantic information such as resolved expression type and intrinsic
   /// information is not cloned.
@@ -56,7 +56,7 @@ class CloneContext {
     return static_cast<T*>(c);
   }
 
-  /// Clones the `Source` @p s into @p mod
+  /// Clones the `Source` `s` into `mod`
   /// TODO(bclayton) - Currently this 'clone' is a shallow copy. If/when
   /// `Source.File`s are owned by the `Module` this should make a copy of the
   /// file.
@@ -64,7 +64,7 @@ class CloneContext {
   /// @return the cloned source
   Source Clone(const Source& s) { return s; }
 
-  /// Clones each of the elements of the vector @p v into the module #mod.
+  /// Clones each of the elements of the vector `v` into the module #mod.
   /// @param v the vector to clone
   /// @return the cloned vector
   template <typename T>

src/ast/decorated_variable.h

@@ -53,7 +53,7 @@ class DecoratedVariable : public Castable<DecoratedVariable, Variable> {
   bool HasConstantIdDecoration() const;
 
   /// @returns the constant_id value for the variable. Assumes that
-  /// |HasConstantIdDecoration| has been called first.
+  /// HasConstantIdDecoration() has been called first.
   uint32_t constant_id() const;
 
   /// Clones this node and all transitive child nodes using the `CloneContext`

src/ast/function.h

@@ -170,7 +170,7 @@ class Function : public Castable<Function, Node> {
   }
   /// Checks if the given entry point is an ancestor
   /// @param name the entry point name
-  /// @returns true if |name| is an ancestor entry point of this function
+  /// @returns true if `name` is an ancestor entry point of this function
   bool HasAncestorEntryPoint(const std::string& name) const;
 
   /// Sets the return type of the function

src/ast/intrinsic.h

@@ -158,29 +158,29 @@ struct TextureSignature : public Signature {
   const Parameters params;
 };
 
-/// Determines if the given |name| is a coarse derivative
+/// Determines if the given `i` is a coarse derivative
 /// @param i the intrinsic
 /// @returns true if the given derivative is coarse.
 bool IsCoarseDerivative(Intrinsic i);
 
-/// Determines if the given |name| is a fine derivative
+/// Determines if the given `i` is a fine derivative
 /// @param i the intrinsic
 /// @returns true if the given derivative is fine.
 bool IsFineDerivative(Intrinsic i);
 
-/// Determine if the given |name| is a derivative intrinsic
+/// Determine if the given `i` is a derivative intrinsic
 /// @param i the intrinsic
-/// @returns true if the given |name| is a derivative intrinsic
+/// @returns true if the given `i` is a derivative intrinsic
 bool IsDerivative(Intrinsic i);
 
-/// Determines if the given |name| is a float classification intrinsic
+/// Determines if the given `i` is a float classification intrinsic
 /// @param i the intrinsic
-/// @returns true if the given |name| is a float intrinsic
+/// @returns true if the given `i` is a float intrinsic
 bool IsFloatClassificationIntrinsic(Intrinsic i);
 
-/// Determines if the given |name| is a texture operation intrinsic
+/// Determines if the given `i` is a texture operation intrinsic
 /// @param i the intrinsic
-/// @returns true if the given |name| is a texture operation intrinsic
+/// @returns true if the given `i` is a texture operation intrinsic
 bool IsTextureIntrinsic(Intrinsic i);
 
 }  // namespace intrinsic

src/ast/module.h

@@ -40,7 +40,8 @@ class Module {
   Module();
   /// Move constructor
   Module(Module&&);
-  // Move assignment
+  /// Move assignment
+  /// @param rhs the Module to move
   Module& operator=(Module&& rhs);
   ~Module();
 

src/ast/node.h

@@ -59,7 +59,7 @@ class Node : public Castable<Node> {
   /// @param indent number of spaces to indent the node when writing
   virtual void to_str(std::ostream& out, size_t indent) const = 0;
 
-  /// Convenience wrapper around the |to_str| method.
+  /// Convenience wrapper around the to_str() method.
   /// @returns the node as a string
   std::string str() const;
 

src/ast/type/type.h

@@ -42,7 +42,7 @@ class Type : public Castable<Type> {
   /// @return the newly cloned type
   virtual Type* Clone(CloneContext* ctx) const = 0;
 
-  /// @returns the name for this type. The |type_name| is unique over all types.
+  /// @returns the name for this type. The type name is unique over all types.
   virtual std::string type_name() const = 0;
 
   /// @param mem_layout type of memory layout to use in calculation.
@@ -55,7 +55,7 @@ class Type : public Castable<Type> {
   ///          0 for non-host shareable types.
   virtual uint64_t BaseAlignment(MemoryLayout mem_layout) const;
 
-  /// @returns the pointee type if this is a pointer, |this| otherwise
+  /// @returns the pointee type if this is a pointer, `this` otherwise
   Type* UnwrapPtrIfNeeded();
 
   /// Removes all levels of aliasing and access control.

src/ast/type_manager.h

@@ -32,6 +32,7 @@ class TypeManager {
   /// Move constructor
   TypeManager(TypeManager&&);
   // Move assignment
+  /// @param rhs the TypeManager to move
   TypeManager& operator=(TypeManager&& rhs);
   ~TypeManager();