From c4ea047cb9a46eefc17279a9d7957e98b2dc4b05 Mon Sep 17 00:00:00 2001 From: Mathieu Lacage Date: Sat, 21 Jun 2008 21:08:16 -0700 Subject: [PATCH] add documentation comment. --- src/common/packet-metadata.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/common/packet-metadata.h b/src/common/packet-metadata.h index 6358cb7de..569546727 100644 --- a/src/common/packet-metadata.h +++ b/src/common/packet-metadata.h @@ -137,6 +137,13 @@ public: void AddTrailer (Trailer const &trailer, uint32_t size); void RemoveTrailer (Trailer const &trailer, uint32_t size); + /** + * \param start the amount of stuff to remove from the start + * \param end the amount of stuff to remove from the end + * + * Calling this method is equivalent to calling RemoveAtStart (start) + * and then, RemoveAtEnd (end). + */ PacketMetadata CreateFragment (uint32_t start, uint32_t end) const; void AddAtEnd (PacketMetadata const&o); void AddPaddingAtEnd (uint32_t end);