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>
This commit is contained in:
parent
03eaff3b0a
commit
94b36c3e86
|
@ -39,9 +39,6 @@ class BoundArrayAccessors : public Transform {
|
||||||
~BoundArrayAccessors() override;
|
~BoundArrayAccessors() override;
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
|
@ -33,9 +33,6 @@ class EmitVertexPointSize : public Transform {
|
||||||
~EmitVertexPointSize() override;
|
~EmitVertexPointSize() override;
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
|
@ -69,9 +69,6 @@ class FirstIndexOffset : public Transform {
|
||||||
~FirstIndexOffset() override;
|
~FirstIndexOffset() override;
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
|
@ -34,9 +34,6 @@ class Hlsl : public Transform {
|
||||||
~Hlsl() override;
|
~Hlsl() override;
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
|
@ -26,9 +26,10 @@
|
||||||
namespace tint {
|
namespace tint {
|
||||||
namespace transform {
|
namespace transform {
|
||||||
|
|
||||||
/// Manager for the provided passes. The passes will be execute in the
|
/// A collection of Transforms that act as a single Transform.
|
||||||
/// appended order. If any pass fails the manager will return immediately and
|
/// The inner transforms will execute in the appended order.
|
||||||
/// the error can be retrieved with the error() method.
|
/// 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 {
|
class Manager : public Transform {
|
||||||
public:
|
public:
|
||||||
/// Constructor
|
/// Constructor
|
||||||
|
|
|
@ -30,9 +30,6 @@ class Msl : public Transform {
|
||||||
~Msl() override;
|
~Msl() override;
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
|
@ -34,9 +34,6 @@ class Spirv : public Transform {
|
||||||
~Spirv() override;
|
~Spirv() override;
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
|
@ -54,9 +54,6 @@ class Transform {
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
virtual Output Run(const Program* program) = 0;
|
virtual Output Run(const Program* program) = 0;
|
||||||
|
|
|
@ -160,9 +160,6 @@ class VertexPulling : public Transform {
|
||||||
void SetPullingBufferBindingGroup(uint32_t number);
|
void SetPullingBufferBindingGroup(uint32_t number);
|
||||||
|
|
||||||
/// Runs the transform on `program`, returning the transformation result.
|
/// 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
|
/// @param program the source program to transform
|
||||||
/// @returns the transformation result
|
/// @returns the transformation result
|
||||||
Output Run(const Program* program) override;
|
Output Run(const Program* program) override;
|
||||||
|
|
Loading…
Reference in New Issue