src/transform: Remove @notes that are no longer true
The transform::Manager no longer does anything special. It is now a container of transforms that acts like a single transform.
Change-Id: I5e51e250cfa610b651445b7cd5efd29811c56d2e
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/42261
Commit-Queue: Ben Clayton <bclayton@google.com>
Reviewed-by: Ryan Harrison <rharrison@chromium.org>
diff --git a/src/transform/bound_array_accessors.h b/src/transform/bound_array_accessors.h
index 7c97a8b..899e7d3 100644
--- a/src/transform/bound_array_accessors.h
+++ b/src/transform/bound_array_accessors.h
@@ -39,9 +39,6 @@
~BoundArrayAccessors() override;
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
diff --git a/src/transform/emit_vertex_point_size.h b/src/transform/emit_vertex_point_size.h
index edd07fa..210cd51 100644
--- a/src/transform/emit_vertex_point_size.h
+++ b/src/transform/emit_vertex_point_size.h
@@ -33,9 +33,6 @@
~EmitVertexPointSize() override;
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
diff --git a/src/transform/first_index_offset.h b/src/transform/first_index_offset.h
index ffbf496..b8983ae 100644
--- a/src/transform/first_index_offset.h
+++ b/src/transform/first_index_offset.h
@@ -69,9 +69,6 @@
~FirstIndexOffset() override;
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
diff --git a/src/transform/hlsl.h b/src/transform/hlsl.h
index 193e54b..a313c93 100644
--- a/src/transform/hlsl.h
+++ b/src/transform/hlsl.h
@@ -34,9 +34,6 @@
~Hlsl() override;
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
diff --git a/src/transform/manager.h b/src/transform/manager.h
index 0816ce0..f2f4341 100644
--- a/src/transform/manager.h
+++ b/src/transform/manager.h
@@ -26,9 +26,10 @@
namespace tint {
namespace transform {
-/// Manager for the provided passes. The passes will be execute in the
-/// appended order. If any pass fails the manager will return immediately and
-/// the error can be retrieved with the error() method.
+/// A collection of Transforms that act as a single Transform.
+/// The inner transforms will execute in the appended order.
+/// If any inner transform fails the manager will return immediately and
+/// the error can be retrieved with the Output's diagnostics.
class Manager : public Transform {
public:
/// Constructor
diff --git a/src/transform/msl.h b/src/transform/msl.h
index b437608..d98ae6c 100644
--- a/src/transform/msl.h
+++ b/src/transform/msl.h
@@ -30,9 +30,6 @@
~Msl() override;
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
diff --git a/src/transform/spirv.h b/src/transform/spirv.h
index 5f79d81..cb67e73 100644
--- a/src/transform/spirv.h
+++ b/src/transform/spirv.h
@@ -34,9 +34,6 @@
~Spirv() override;
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
diff --git a/src/transform/transform.h b/src/transform/transform.h
index c3f05c1..3516259 100644
--- a/src/transform/transform.h
+++ b/src/transform/transform.h
@@ -54,9 +54,6 @@
};
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
virtual Output Run(const Program* program) = 0;
diff --git a/src/transform/vertex_pulling.h b/src/transform/vertex_pulling.h
index 3db054d..215052e 100644
--- a/src/transform/vertex_pulling.h
+++ b/src/transform/vertex_pulling.h
@@ -160,9 +160,6 @@
void SetPullingBufferBindingGroup(uint32_t number);
/// Runs the transform on `program`, returning the transformation result.
- /// @note Users of Tint should register the transform with transform manager
- /// and invoke its Run(), instead of directly calling the transform's Run().
- /// Calling Run() directly does not perform program state cleanup operations.
/// @param program the source program to transform
/// @returns the transformation result
Output Run(const Program* program) override;
