add comment on Checksum::clear

Fixes #521
p4lang · Jan 20, 2018 · 2de08ea · 2de08ea
1 parent 23565e5
commit 2de08ea
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/p4-16/psa/psa.p4 b/p4-16/psa/psa.p4
@@ -304,7 +304,12 @@ extern Checksum<W> {
   /// Constructor
   Checksum(PSA_HashAlgorithm_t hash);
 
-  /// Reset internal state and prepare unit for computation
+  /// Reset internal state and prepare unit for computation.
+  /// Every instance of a Checksum object is automatically initialized as
+  /// if clear() had been called on it. This initialization happens every
+  /// time the object is instantiated, that is, whenever the parser or control
+  /// containing the Checksum object are applied.
+  /// All state maintained by the Checksum object is independent per packet.
   void clear();
 
   /// Add data to checksum