X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketData.hh;h=2f8a5210727c482aff8b9dc9cd68863635d3e39c;hb=43f2010f6e4eb9a3c972b98b350f13733e583fc6;hp=9ebe32e8999131870f648477ac06b1a47d1e1418;hpb=d084c02e4914da4fa1a4098a33d704f69e8bdedd;p=senf.git
diff --git a/Packets/PacketData.hh b/Packets/PacketData.hh
index 9ebe32e..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);
@@ -109,13 +115,19 @@ namespace senf {
// only academic since what should an empty packet be good for ?
void insert(iterator pos, byte v);
void insert(iterator pos, size_type n, byte v);
+# ifndef DOXYGEN
template
void insert(iterator pos, InputIterator f, InputIterator l,
typename boost::disable_if< boost::is_convertible >::type * = 0);
+# else
+ template
+ void insert(iterator pos, InputIterator f, InputIterator l);
+# endif
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);