X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketData.hh;h=2f8a5210727c482aff8b9dc9cd68863635d3e39c;hb=2a5995bedd9e4861dce1a70a460fdeb7bd0f2ad7;hp=8a64ec02f58d7c0ecd10bcc536b1abb5b46fd7b0;hpb=96d591f9024bc536e0a643b40c2bf243241d342d;p=senf.git
diff --git a/Packets/PacketData.hh b/Packets/PacketData.hh
index 8a64ec0..2f8a521 100644
--- a/Packets/PacketData.hh
+++ b/Packets/PacketData.hh
@@ -95,10 +95,16 @@ namespace senf {
///\name Sequence interface to raw data
///@{
- iterator begin() const;
- iterator end() const;
- size_type size() const;
- bool empty() const;
+ iterator begin() const; /**< Returns an random access iterator referring
+ to the first byte of the packet data. */
+ iterator end() const; /**< Returns an random access iterator referring to the
+ element past the end of the packet data. */
+ size_type size() const; ///< Returns the number of bytes in the packet data.
+ bool empty() const; ///< Test whether the packet data is empty.
+ /**< Returns whether the packet data is empty, i.e.
+ whether its size is 0. This function does not modify
+ the content of the packet data in any way. To clear
+ the content use clear() */
byte operator[](size_type n) const;
byte & operator[](size_type n);
@@ -120,7 +126,8 @@ namespace senf {
void erase(iterator pos);
void erase(iterator first, iterator last);
- void clear();
+ void clear(); /**< All bytes of the packet data dropped,
+ leaving the container with a size of 0. */
void resize(size_type n, byte v=0);