trunk/branch integration: documentation

This commit is contained in:
Marian Krivos 2011-08-23 07:11:28 +00:00
parent 4d860e1b18
commit 73d3dceb86

View File

@ -64,12 +64,14 @@ class Foundation_API TextIterator
/// int n = 0;
/// while (it != end) { ++n; ++it; }
///
/// NOTE: When an UTF-16 encoding is used, surrogate pairs will be
/// reported as two separate characters, due to restrictions of
/// the TextEncoding class.
/// NOTE: When an UTF-16 encoding is used, surrogate pairs will be
/// reported as two separate characters, due to restrictions of
/// the TextEncoding class.
///
/// For iterating over char buffers, see the TextBufferIterator class.
{
public:
TextIterator();
TextIterator();
/// Creates an uninitialized TextIterator.
TextIterator(const std::string& str, const TextEncoding& encoding);
@ -114,12 +116,16 @@ public:
bool operator == (const TextIterator& it) const;
/// Compares two iterators for equality.
bool operator != (const TextIterator& it) const;
/// Compares two iterators for inequality.
bool operator != (const TextIterator& it) const;
/// Compares two iterators for inequality.
TextIterator end() const;
/// Returns the end iterator for the range handled
/// by the iterator.
private:
const TextEncoding* _pEncoding;
std::string::const_iterator _it;
const TextEncoding* _pEncoding;
std::string::const_iterator _it;
std::string::const_iterator _end;
};
@ -145,6 +151,12 @@ inline void swap(TextIterator& it1, TextIterator& it2)
}
inline TextIterator TextIterator::end() const
{
return TextIterator(_end);
}
} // namespace Poco