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 <dsinclair@chromium.org>
Commit-Queue: Ryan Harrison <rharrison@chromium.org>
Reviewed-by: Ryan Harrison <rharrison@chromium.org>
This commit is contained in:
dan sinclair 2020-10-06 15:35:37 +00:00 committed by Commit Bot service account
parent b8d90ead93
commit dd516e6b64
5 changed files with 9 additions and 0 deletions

View File

@ -42,7 +42,9 @@ class FunctionDecoration {
/// Outputs the function decoration to the given stream /// Outputs the function decoration to the given stream
/// @param out the stream to output too /// @param out the stream to output too
//! @cond Doxygen_Suppress
virtual void to_str(std::ostream& out) const = 0; virtual void to_str(std::ostream& out) const = 0;
//! @endcond
protected: protected:
FunctionDecoration(); FunctionDecoration();

View File

@ -45,7 +45,9 @@ class Node {
/// Writes a representation of the node to the output stream /// Writes a representation of the node to the output stream
/// @param out the stream to write to /// @param out the stream to write to
/// @param indent number of spaces to indent the node when writing /// @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; virtual void to_str(std::ostream& out, size_t indent) const = 0;
//! @endcond
/// Convenience wrapper around the |to_str| method. /// Convenience wrapper around the |to_str| method.
/// @returns the node as a string /// @returns the node as a string

View File

@ -58,7 +58,9 @@ class VariableDecoration {
/// Outputs the variable decoration to the given stream /// Outputs the variable decoration to the given stream
/// @param out the stream to output too /// @param out the stream to output too
//! @cond Doxygen_Suppress
virtual void to_str(std::ostream& out) const = 0; virtual void to_str(std::ostream& out) const = 0;
//! @endcond
protected: protected:
VariableDecoration(); VariableDecoration();

View File

@ -50,6 +50,7 @@ class GeneratorImpl : public TextGenerator {
/// @param module the module to generate from /// @param module the module to generate from
/// @param stage the pipeline stage /// @param stage the pipeline stage
/// @param name the entry point name /// @param name the entry point name
/// @returns true on successful generation; false otherwise
bool GenerateEntryPoint(const ast::Module& module, bool GenerateEntryPoint(const ast::Module& module,
ast::PipelineStage stage, ast::PipelineStage stage,
const std::string& name); const std::string& name);

View File

@ -32,7 +32,9 @@ class Writer {
const std::string& error() const { return error_; } const std::string& error() const { return error_; }
/// Resets the generator /// Resets the generator
//! @cond Doxygen_Suppress
virtual void Reset() = 0; virtual void Reset() = 0;
//! @endcond
/// Converts the module into the desired format /// Converts the module into the desired format
/// @returns true on success; false on failure /// @returns true on success; false on failure