remove dead reference to EnableMetadata
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 08 Jun 2009 09:24:25 +0200
changeset 4507 7b4adb81e21e
parent 4506 5e742340ef51
child 4508 3135a5c24358
remove dead reference to EnableMetadata
src/common/packet.h
--- a/src/common/packet.h	Mon Jun 08 09:22:29 2009 +0200
+++ b/src/common/packet.h	Mon Jun 08 09:24:25 2009 +0200
@@ -166,8 +166,10 @@
  * - The metadata describes the type of the headers and trailers which
  * were serialized in the byte buffer. The maintenance of metadata is
  * optional and disabled by default. To enable it, you must call
- * Packet::EnableMetadata and this will allow you to get non-empty
- * output from Packet::Print and Packet::Print.
+ * Packet::EnablePrinting and this will allow you to get non-empty
+ * output from Packet::Print and Packet::Print. If you wish to only enable
+ * checking of metadata, and do not need any printing capability, you can
+ * call Packet::EnableChecking: its runtime cost is lower than Packet::EnablePrinting.
  *
  * - The set of tags contain simulation-specific information which cannot
  * be stored in the packet byte buffer because the protocol headers or trailers