From dd516e6b64210718d00862918e10d2f974552443 Mon Sep 17 00:00:00 2001 From: dan sinclair Date: Tue, 6 Oct 2020 15:35:37 +0000 Subject: [PATCH] Doxygen cleanup This CL suppresses some Doxygen warnings for code doxygen doesn't process correctly and adds the missing return for GenerateEntryPoint method. Change-Id: If97443a7177caa51c1054de83fb0711692a7ab22 Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/29461 Commit-Queue: dan sinclair Commit-Queue: Ryan Harrison Reviewed-by: Ryan Harrison --- src/ast/function_decoration.h | 2 ++ src/ast/node.h | 2 ++ src/ast/variable_decoration.h | 2 ++ src/writer/wgsl/generator_impl.h | 1 + src/writer/writer.h | 2 ++ 5 files changed, 9 insertions(+) diff --git a/src/ast/function_decoration.h b/src/ast/function_decoration.h index fb1e3bbf58..d7671382c0 100644 --- a/src/ast/function_decoration.h +++ b/src/ast/function_decoration.h @@ -42,7 +42,9 @@ class FunctionDecoration { /// Outputs the function decoration to the given stream /// @param out the stream to output too + //! @cond Doxygen_Suppress virtual void to_str(std::ostream& out) const = 0; + //! @endcond protected: FunctionDecoration(); diff --git a/src/ast/node.h b/src/ast/node.h index 97c3bcf85c..f02d85edcd 100644 --- a/src/ast/node.h +++ b/src/ast/node.h @@ -45,7 +45,9 @@ class Node { /// Writes a representation of the node to the output stream /// @param out the stream to write to /// @param indent number of spaces to indent the node when writing + //! @cond Doxygen_Suppress virtual void to_str(std::ostream& out, size_t indent) const = 0; + //! @endcond /// Convenience wrapper around the |to_str| method. /// @returns the node as a string diff --git a/src/ast/variable_decoration.h b/src/ast/variable_decoration.h index fe62123c1a..8cc5f70dc3 100644 --- a/src/ast/variable_decoration.h +++ b/src/ast/variable_decoration.h @@ -58,7 +58,9 @@ class VariableDecoration { /// Outputs the variable decoration to the given stream /// @param out the stream to output too + //! @cond Doxygen_Suppress virtual void to_str(std::ostream& out) const = 0; + //! @endcond protected: VariableDecoration(); diff --git a/src/writer/wgsl/generator_impl.h b/src/writer/wgsl/generator_impl.h index 0a9e6f4056..37be9cb57a 100644 --- a/src/writer/wgsl/generator_impl.h +++ b/src/writer/wgsl/generator_impl.h @@ -50,6 +50,7 @@ class GeneratorImpl : public TextGenerator { /// @param module the module to generate from /// @param stage the pipeline stage /// @param name the entry point name + /// @returns true on successful generation; false otherwise bool GenerateEntryPoint(const ast::Module& module, ast::PipelineStage stage, const std::string& name); diff --git a/src/writer/writer.h b/src/writer/writer.h index 51e0307d67..b38657be62 100644 --- a/src/writer/writer.h +++ b/src/writer/writer.h @@ -32,7 +32,9 @@ class Writer { const std::string& error() const { return error_; } /// Resets the generator + //! @cond Doxygen_Suppress virtual void Reset() = 0; + //! @endcond /// Converts the module into the desired format /// @returns true on success; false on failure