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

@ -67,6 +67,8 @@ class Foundation_API TextIterator
/// 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();
@ -117,6 +119,10 @@ public:
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;
@ -145,6 +151,12 @@ inline void swap(TextIterator& it1, TextIterator& it2)
}
inline TextIterator TextIterator::end() const
{
return TextIterator(_end);
}
} // namespace Poco