X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FParseArray.ih;h=d07c26fcdc3b6cfbf92575415367a2e52ab425bf;hb=81ffa1c459b96dd44472bcef37e1e373934ee138;hp=7ea3d5063af691353bc62479ee6aacbd3d12ceca;hpb=47368f306a577d1e46df69a7f729bd3893cbe5e7;p=senf.git diff --git a/Packets/ParseArray.ih b/Packets/ParseArray.ih index 7ea3d50..d07c26f 100644 --- a/Packets/ParseArray.ih +++ b/Packets/ParseArray.ih @@ -20,6 +20,9 @@ // Free Software Foundation, Inc., // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +/** \file + \brief ParseArray internal header */ + #ifndef IH_ParseArray_ #define IH_ParseArray_ 1 @@ -28,6 +31,13 @@ ///////////////////////////////ih.p//////////////////////////////////////// +/** \brief Internal: Array and Vector iterator + + \internal + + This is the iterator type used for both Parse_Array and Parse_Vector. It is a model of random + access iterator. + */ template class senf::detail::Parse_Array_iterator : public boost::iterator_facade< Parse_Array_iterator, @@ -43,7 +53,9 @@ public: // Needed to elide the []-proxy of iterator_facade ElementParser operator[](int i) const; - PacketParserBase::data_iterator raw() const; + PacketParserBase::data_iterator raw() const; ///< Return data_iterator + /**< Returns the raw data_iterator pointing to the beginning + of the current element */ protected: @@ -74,4 +86,5 @@ private: // indent-tabs-mode: nil // ispell-local-dictionary: "american" // compile-command: "scons -u test" +// comment-column: 40 // End: