4.06.2013 - Version 0.3.4 - PIOBJECT() macro, ethernet improvement, documentation based on Doxygen

pistring.h

@@ -1,3 +1,8 @@
+/*! \file pistring.h
+ * \brief String
+ * 
+ * This file declare string and string list classes
+*/
 /*
     PIP - Platform Independent Primitives
     String
@@ -26,13 +31,14 @@
 
 class PIStringList;
 
-class PIString: public PIVector<PIChar>
+class PIP_EXPORT PIString: public PIVector<PIChar>
 {
 public:
-	PIString() {piMonitor.strings++; piMonitor.containers--;}
+	//! Contructs an empty string
+	PIString() {reserve(256); piMonitor.strings++; piMonitor.containers--;}
 
 	//inline PIString & operator +=(const char c) {push_back(c); return *this;}
-	PIString & operator +=(const PIChar c) {push_back(c); return *this;}
+	PIString & operator +=(const PIChar & c) {push_back(c); return *this;}
 	PIString & operator +=(const char * str);
 	PIString & operator +=(const wchar_t * str);
 	PIString & operator +=(const string & str) {appendFromChars(str.c_str(), str.length()); return *this;}
@@ -43,107 +49,335 @@ public:
 #endif
 
 	//PIString(const char c) {*this += c;}
-	PIString(const PIChar c) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += c;}
+	
+	//! Contructs string with single symbol "c"
+	PIString(const PIChar & c) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += c;}
+	
+	/*! \brief Contructs string from c-string "str"
+	 * \details "str" should be null-terminated\n
+	 * Example: \snippet pistring.cpp PIString(char * ) */
 	PIString(const char * str) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += str;}
+	
+	/*! \brief Contructs string from \c wchar_t c-string "str"
+	 * \details "str" should be null-terminated\n
+	 * Example: \snippet pistring.cpp PIString(wchar_t * ) */
 	PIString(const wchar_t * str) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += str;}
+	
+	//! Contructs string from std::string "str"
 	PIString(const string & str) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += str;}
-#ifdef HAS_LOCALE
+
+	#ifdef HAS_LOCALE
 	PIString(const wstring & str) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += str;}
 #endif
+
+	//! Contructs string from byte array "ba"
 	PIString(const PIByteArray & ba) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += ba;}
+
+	/*! \brief Contructs string from "len" characters of buffer "str"
+	 * \details Example: \snippet pistring.cpp PIString(char * , int) */
 	PIString(const char * str, const int len) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += string(str, len);}
+
+	/*! \brief Contructs string as sequence of characters "c" of buffer with length "len"
+	 * \details Example: \snippet pistring.cpp PIString(int, char) */
 	PIString(const int len, const char c) {reserve(256); piMonitor.strings++; piMonitor.containers--; for (int i = 0; i < len; ++i) push_back(c);}
+
+	/*! \brief Contructs string as sequence of symbols "c" of buffer with length "len"
+	 * \details Example: \snippet pistring.cpp PIString(int, PIChar) */
 	PIString(const int len, const PIChar & c) {reserve(256); piMonitor.strings++; piMonitor.containers--; for (int i = 0; i < len; ++i) push_back(c);}
+
+	//! Contructs string from other string "str"
 	PIString(const PIString & str) {reserve(256); piMonitor.strings++; piMonitor.containers--; *this += str;}
+
 	~PIString() {piMonitor.strings--; piMonitor.containers++;}
 
+
+	/*! \brief Return c-string representation of string
+	 * \details Converts content of string to c-string and return
+	 * pointer to first char. This buffer is valid until new convertion
+	 * or execution \a data() or \a toByteArray().\n
+	 * Example: \snippet pistring.cpp PIString::char* */
 	operator const char*() {return data();}
+
+	//! Return std::string representation of string
 	operator const string() {if (size() == 0) return string(); string s; for (int i = 0; i < length(); ++i) s.push_back(at(i).toAscii()); return s;}
+	
+	//! Return symbol at index "pos"
 	PIChar operator [](const int pos) const {return at(pos);}
+	
+	//! Return const reference symbol at index "pos"
 	PIChar & operator [](const int pos) {return at(pos);}
 
+	//! Compare operator
 	bool operator ==(const PIString & str) const;
+
+	//! Compare operator
 	bool operator ==(const PIChar c) const {return *this == PIString(c);}
 	//inline bool operator ==(const char c) const {return *this == PIString(c);}
+
+	//! Compare operator
 	bool operator ==(const char * str) const {return *this == PIString(str);}
+
+	//! Compare operator
 	bool operator ==(const string & str) const {return *this == PIString(str);}
 
+
+	//! Compare operator
 	bool operator !=(const PIString & str) const;
+
+	//! Compare operator
 	bool operator !=(const PIChar c) const {return *this != PIString(c);}
 	//inline bool operator !=(const char c) const {return *this != PIString(c);}
+
+	//! Compare operator
 	bool operator !=(const char * str) const {return *this != PIString(str);}
+
+	//! Compare operator
 	bool operator !=(const string & str) const {return *this != PIString(str);}
 
+
+	//! Compare operator
 	bool operator <(const PIString & str) const;
+
+	//! Compare operator
 	bool operator <(const PIChar c) const {return *this < PIString(c);}
 	//inline bool operator <(const char c) const {return *this < PIString(c);}
+
+	//! Compare operator
 	bool operator <(const char * str) const {return *this < PIString(str);}
+
+	//! Compare operator
 	bool operator <(const string & str) const {return *this < PIString(str);}
 
+
+	//! Compare operator
 	bool operator >(const PIString & str) const;
+
+	//! Compare operator
 	bool operator >(const PIChar c) const {return *this > PIString(c);}
 	//inline bool operator >(const char c) const {return *this > PIString(c);}
+
+	//! Compare operator
 	bool operator >(const char * str) const {return *this > PIString(str);}
+
+	//! Compare operator
 	bool operator >(const string & str) const {return *this > PIString(str);}
 
+
+	//! Compare operator
 	bool operator <=(const PIString & str) const {return !(*this > str);}
+
+	//! Compare operator
 	bool operator <=(const PIChar c) const {return *this <= PIString(c);}
 	//inline bool operator <=(const char c) const {return *this <= PIString(c);}
+
+	//! Compare operator
 	bool operator <=(const char * str) const {return *this <= PIString(str);}
+
+	//! Compare operator
 	bool operator <=(const string & str) const {return *this <= PIString(str);}
 
+
+	//! Compare operator
 	bool operator >=(const PIString & str) const {return !(*this < str);}
+
+	//! Compare operator
 	bool operator >=(const PIChar c) const {return *this >= PIString(c);}
 	//inline bool operator >=(const char c) const {return *this >= PIString(c);}
+
+	//! Compare operator
 	bool operator >=(const char * str) const {return *this >= PIString(str);}
+
+	//! Compare operator
 	bool operator >=(const string & str) const {return *this >= PIString(str);}
 
+
+	/*! \brief Append string "str" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(PIString) */
 	PIString & operator <<(const PIString & str) {*this += str; return *this;}
 	//inline PIString & operator <<(const char c) {*this += c; return *this;}
-	PIString & operator <<(const PIChar c) {*this += c; return *this;}
+
+	/*! \brief Append symbol "c" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(PIChar) */
+	PIString & operator <<(const PIChar & c) {*this += c; return *this;}
+
+	/*! \brief Append c-string "str" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(char * ) */
 	PIString & operator <<(const char * str) {*this += str; return *this;}
+
+	/*! \brief Append \c wchar_t c-string "str" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(wchar_t * ) */
 	PIString & operator <<(const wchar_t * str) {*this += str; return *this;}
+	
+	//! Append std::string "str" at the end of string
 	PIString & operator <<(const string & str) {*this += str; return *this;}
+
+	/*! \brief Append string representation of "num" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(int) */
 	PIString & operator <<(const int & num) {*this += PIString::fromNumber(num); return *this;}
+	
+	/*! \brief Append string representation of "num" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(int) */
 	PIString & operator <<(const short & num) {*this += PIString::fromNumber(num); return *this;}
+	
+	/*! \brief Append string representation of "num" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(int) */
 	PIString & operator <<(const long & num) {*this += PIString::fromNumber(num); return *this;}
+	
+	/*! \brief Append string representation of "num" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(int) */
 	PIString & operator <<(const float & num) {*this += PIString::fromNumber(num); return *this;}
+	
+	/*! \brief Append string representation of "num" at the end of string
+	 * \details Example: \snippet pistring.cpp PIString::<<(int) */
 	PIString & operator <<(const double & num) {*this += PIString::fromNumber(num); return *this;}
 
+	
+	/*! \brief Return part of string from symbol at index "start" and maximum length "len"
+	 * \details All variants demonstrated in example: \snippet pistring.cpp PIString::mid
+	 * \sa \a left(), \a right() */
 	PIString mid(const int start, const int len = -1) const;
+	
+	/*! \brief Return part of string from left and maximum length "len"
+	 * \details Example: \snippet pistring.cpp PIString::left
+	 * \sa \a mid(), \a right() */
 	PIString left(const int len) const {return len <= 0 ? PIString() : mid(0, len);}
+	
+	/*! \brief Return part of string from right and maximum length "len"
+	 * \details Example: \snippet pistring.cpp PIString::right
+	 * \sa \a mid(), \a left() */
 	PIString right(const int len) const {return len <= 0 ? PIString() : mid(size() - len, len);}
+	
+	/*! \brief Remove part of string from symbol as index "start" and maximum length "len"
+	 * and return this string
+	 * \details All variants demonstrated in example: \snippet pistring.cpp PIString::cutMid
+	 * \sa \a cutLeft(), \a cutRight() */
 	PIString & cutMid(const int start, const int len);
+	
+	/*! \brief Remove part of string from left and maximum length "len" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::cutLeft
+	 * \sa \a cutMid(), \a cutRight() */
 	PIString & cutLeft(const int len) {return len <= 0 ? *this : cutMid(0, len);}
+	
+	/*! \brief Remove part of string from right and maximum length "len" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::cutRight
+	 * \sa \a cutMid(), \a cutLeft() */
 	PIString & cutRight(const int len) {return len <= 0 ? *this : cutMid(size() - len, len);}
+	
+	/*! \brief Remove spaces at the start and at the end of string and return this string
+	 * \details Example: \snippet pistring.cpp PIString::trim
+	 * \sa \a trimmed() */
 	PIString & trim();
+	
+	/*! \brief Return copy of this string without spaces at the start and at the end
+	 * \details Example: \snippet pistring.cpp PIString::trimmed
+	 * \sa \a trim() */
 	PIString   trimmed() const;
+	
+	/*! \brief Replace part of string from index "from" and maximum length "len"
+	 * with string "with" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::replace_0
+	 * \sa \a replaced(), \a replaceAll() */
 	PIString & replace(const int from, const int count, const PIString & with);
+	
+	/*! \brief Replace part copy of this string from index "from" and maximum length "len"
+	 * with string "with" and return copied string
+	 * \details Example: \snippet pistring.cpp PIString::replaced_0
+	 * \sa \a replace(), \a replaceAll() */
 	PIString   replaced(const int from, const int count, const PIString & with) const {PIString str(*this); str.replace(from, count, with); return str;}
+	
+	/*! \brief Replace first founded substring "what" with string "with" and return this string
+	 * \details If "ok" is not null, it set to "true" if something was replaced\n
+	 * Example: \snippet pistring.cpp PIString::replace_1
+	 * \sa \a replaced(), \a replaceAll() */
 	PIString & replace(const PIString & what, const PIString & with, bool * ok = 0);
+	
+	/*! \brief Replace first founded substring "what" with string "with" and return copied string
+	 * \details If "ok" is not null, it set to "true" if something was replaced\n
+	 * Example: \snippet pistring.cpp PIString::replaced_1
+	 * \sa \a replaced(), \a replaceAll() */
 	PIString   replaced(const PIString & what, const PIString & with, bool * ok = 0) const {PIString str(*this); str.replace(what, with, ok); return str;}
+	
+	/*! \brief Replace all founded substrings "what" with strings "with" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::replaceAll
+	 * \sa \a replace(), \a replaced() */
 	PIString & replaceAll(const PIString & what, const PIString & with);
 	PIString   replaceAll(const PIString & what, const PIString & with) const {PIString str(*this); str.replaceAll(what, with); return str;}
+	
+	/*! \brief Insert symbol "c" after index "index" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::insert_0 */
 	PIString & insert(const int index, const PIChar & c) {PIVector<PIChar>::insert(index, c); return *this;}
+	
+	/*! \brief Insert symbol "c" after index "index" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::insert_1 */
 	PIString & insert(const int index, const char & c) {return insert(index, PIChar(c));}
+	
+	/*! \brief Insert string "str" after index "index" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::insert_2 */
 	PIString & insert(const int index, const PIString & str);
+	
+	/*! \brief Insert string "str" after index "index" and return this string
+	 * \details Example: \snippet pistring.cpp PIString::insert_2 */
 	PIString & insert(const int index, const char * c) {return insert(index, PIString(c));}
+	
+	/*! \brief Enlarge string to length "len" by addition sequence of symbols
+	 * "c" at the end of string, and return this string
+	 * \details Example: \snippet pistring.cpp PIString::expandRightTo
+	 * \sa \a expandLeftTo() */
 	PIString & expandRightTo(const int len, const PIChar & c) {if (len > length()) resize(len, c); return *this;}
+	
+	/*! \brief Enlarge string to length "len" by addition sequence of symbols
+	 * "c" at the beginning of string, and return this string
+	 * \details Example: \snippet pistring.cpp PIString::expandLeftTo
+	 * \sa \a expandRightTo() */
 	PIString & expandLeftTo(const int len, const PIChar & c) {if (len > length()) insert(0, PIString(len - length(), c)); return *this;}
+	
+	/*! \brief Reverse string and return this string
+	 * \details Example: \snippet pistring.cpp PIString::reverse 
+	 * \sa \a reversed() */
 	PIString & reverse() {PIString str(*this); clear(); piForeachR (const PIChar & c, str) push_back(c); return *this;}
+	
+	/*! \brief Reverse copy of this string and return it
+	 * \details Example: \snippet pistring.cpp PIString::reversed
+	 * \sa \a reverse() */
 	PIString   reversed() const {PIString str(*this); str.reverse(); return str;}
 
 	//const char * data() {return convertToStd().c_str();}
+	
+	
+	/*! \brief Return real bytes count of this string
+	 * \details It`s equivalent length os char sequence
+	 * returned by function \a data() \n
+	 * Example: \snippet pistring.cpp PIString::lengthAscii
+	 * \sa \a data() */
 	int lengthAscii() const;
+	
+	/*! \brief Return \c char * representation of this string
+	 * \details This function fill buffer by sequence
+	 * of chars. Minimum length of this buffer is count 
+	 * of symbols. Returned \c char * is valid until next
+	 * execution of this function.\n
+	 * Example: \snippet pistring.cpp PIString::data
+	 * \sa \a lengthAscii() */
 	const char * data() const;
+
+	//! \brief Return \c std::string representation of this string
 	const string stdString() const {return convertToStd();}
 #ifdef HAS_LOCALE
 	wstring stdWString() const {return convertToWString();}
 #endif
+
+	//! \brief Return \a PIByteArray contains \a data() of this string
 	PIByteArray toByteArray() const {const char * d = data(); return PIByteArray(d, lengthAscii());}
+
+	/*! \brief Split string with delimiter "delim" to \a PIStringList and return it
+	 * \details Example: \snippet pistring.cpp PIString::split */
 	PIStringList split(const PIString & delim) const;
 
+
+	//! \brief Convert each symbol in copyed string to upper case and return it
 	PIString toUpperCase() const;
+	
+	//! \brief Convert each symbol in copyed string to lower case and return it
 	PIString toLowerCase() const;
 #ifdef HAS_LOCALE
 	PIString toNativeDecimalPoints() const {PIString s(*this); if (currentLocale == 0) return s; return s.replaceAll(".", currentLocale->decimal_point);}
@@ -151,60 +385,199 @@ public:
 	PIString toNativeDecimalPoints() const {PIString s(*this); return s;}
 #endif
 
+	
+	//! \brief Search substring "str" from symbol at index "start" and return first occur position
+	//! \details Example: \snippet pistring.cpp PIString::find
 	int find(const char str, const int start = 0) const;
+	
+	//! \brief Search substring "str" from symbol at index "start" and return first occur position
+	//! \details Example: \snippet pistring.cpp PIString::find
 	int find(const PIString str, const int start = 0) const;
+	
+	//! \brief Search substring "str" from symbol at index "start" and return first occur position
+	//! \details Example: \snippet pistring.cpp PIString::find
 	int find(const char * str, const int start = 0) const {return find(PIString(str), start);}
+	
+	//! \brief Search substring "str" from symbol at index "start" and return first occur position
+	//! \details Example: \snippet pistring.cpp PIString::find
 	int find(const string str, const int start = 0) const {return find(PIString(str), start);}
+	
+	//! \brief Search substring "str" from symbol at index "start" and return last occur position
+	//! \details Example: \snippet pistring.cpp PIString::findLast
 	int findLast(const char str, const int start = 0) const;
+	
+	//! \brief Search substring "str" from symbol at index "start" and return last occur position
+	//! \details Example: \snippet pistring.cpp PIString::findLast
 	int findLast(const PIString str, const int start = 0) const;
+	
+	//! \brief Search substring "str" from symbol at index "start" and return last occur position
+	//! \details Example: \snippet pistring.cpp PIString::findLast
 	int findLast(const char * str, const int start = 0) const {return findLast(PIString(str), start);}
+	
+	//! \brief Search substring "str" from symbol at index "start" and return last occur position
+	//! \details Example: \snippet pistring.cpp PIString::findLast
 	int findLast(const string str, const int start = 0) const {return findLast(PIString(str), start);}
 
+	
+	//! \brief Return symbols length of string
 	int length() const {return size();}
+	
+	//! \brief Return \c true if string is empty, i.e. length = 0
 	bool isEmpty() const {return (size() == 0 || *this == "");}
 
+	
+	//! \brief Return \c true if string equal "true" or "on" or positive numeric value
 	bool toBool() const {PIString s(*this); if (atof(s.toNativeDecimalPoints().data()) > 0. || s.trimmed().toLowerCase() == "true" || s.trimmed().toLowerCase() == "on") return true; return false;}
+	
+	//! \brief Return \c char numeric value of string
 	char toChar() const;
+	
+	//! \brief Return \c short numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	short toShort(int base = -1, bool * ok = 0) const {return short(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c ushort numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	ushort toUShort(int base = -1, bool * ok = 0) const {return ushort(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c int numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	int toInt(int base = -1, bool * ok = 0) const {return int(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c uint numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	uint toUInt(int base = -1, bool * ok = 0) const {return uint(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c long numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	long toLong(int base = -1, bool * ok = 0) const {return long(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c ulong numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	ulong toULong(int base = -1, bool * ok = 0) const {return ulong(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c llong numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	llong toLLong(int base = -1, bool * ok = 0) const {return toNumberBase(*this, base, ok);}
+	
+	//! \brief Return \c ullong numeric value of string in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::toNumber
 	ullong toULLong(int base = -1, bool * ok = 0) const {return ullong(toNumberBase(*this, base, ok));}
+	
+	//! \brief Return \c float numeric value of string
+	//! \details Example: \snippet pistring.cpp PIString::toFloat
 	float toFloat() const {PIString s(*this); return (float)atof(s.toNativeDecimalPoints().data());}
+	
+	//! \brief Return \c double numeric value of string
+	//! \details Example: \snippet pistring.cpp PIString::toFloat
 	double toDouble() const {PIString s(*this); return atof(s.toNativeDecimalPoints().data());}
+	
+	//! \brief Return \c ldouble numeric value of string
+	//! \details Example: \snippet pistring.cpp PIString::toFloat
 	ldouble toLDouble() const {PIString s(*this); return atof(s.toNativeDecimalPoints().data());}
 
 	//inline PIString & setNumber(const char value) {clear(); *this += itos(value); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
 	PIString & setNumber(const short value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
 	PIString & setNumber(const ushort value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
 	PIString & setNumber(const int value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
 	PIString & setNumber(const uint value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
 	PIString & setNumber(const long value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
 	PIString & setNumber(const ulong value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
-	PIString & setNumber(const llong value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
-	PIString & setNumber(const ullong value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
+	PIString & setNumber(const llong & value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::setNumber
+	PIString & setNumber(const ullong & value, int base = 10, bool * ok = 0) {clear(); *this += PIString::fromNumber(value, base, ok); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value"
+	//! \details Example: \snippet pistring.cpp PIString::setFloat
 	PIString & setNumber(const float value) {clear(); *this += ftos(value); return *this;}
-	PIString & setNumber(const double value) {clear(); *this += dtos(value); return *this;}
-	PIString & setNumber(const ldouble value) {clear(); *this += dtos(value); return *this;}
-	PIString & setReadableSize(long bytes);
+	
+	//! \brief Set string content to numeric representation of "value"
+	//! \details Example: \snippet pistring.cpp PIString::setFloat
+	PIString & setNumber(const double & value) {clear(); *this += dtos(value); return *this;}
+	
+	//! \brief Set string content to numeric representation of "value"
+	//! \details Example: \snippet pistring.cpp PIString::setFloat
+	PIString & setNumber(const ldouble & value) {clear(); *this += dtos(value); return *this;}
+	
+	//! \brief Set string content to human readable size in B/kB/MB/GB/TB
+	//! \details Example: \snippet pistring.cpp PIString::setReadableSize
+	PIString & setReadableSize(llong bytes);
 
 	//inline static PIString fromNumber(const char value) {return PIString(itos(value));}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
 	static PIString fromNumber(const short value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
 	static PIString fromNumber(const ushort value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
 	static PIString fromNumber(const int value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
 	static PIString fromNumber(const uint value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
 	static PIString fromNumber(const long value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
 	static PIString fromNumber(const ulong value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
-	static PIString fromNumber(const llong value, int base = 10, bool * ok = 0) {return fromNumberBase(value, base, ok);}
-	static PIString fromNumber(const ullong value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
+	static PIString fromNumber(const llong & value, int base = 10, bool * ok = 0) {return fromNumberBase(value, base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value" in base "base"
+	//! \details Example: \snippet pistring.cpp PIString::fromNumber
+	static PIString fromNumber(const ullong & value, int base = 10, bool * ok = 0) {return fromNumberBase(llong(value), base, ok);}
+	
+	//! \brief Return string contains numeric representation of "value"
+	//! \details Example: \snippet pistring.cpp PIString::fromFloat
 	static PIString fromNumber(const float value) {return PIString(ftos(value));}
-	static PIString fromNumber(const double value) {return PIString(dtos(value));}
-	static PIString fromNumber(const ldouble value) {return PIString(dtos(value));}
+	
+	//! \brief Return string contains numeric representation of "value"
+	//! \details Example: \snippet pistring.cpp PIString::fromFloat
+	static PIString fromNumber(const double & value) {return PIString(dtos(value));}
+	
+	//! \brief Return string contains numeric representation of "value"
+	//! \details Example: \snippet pistring.cpp PIString::fromFloat
+	static PIString fromNumber(const ldouble & value) {return PIString(dtos(value));}
+	
+	//! \brief Return "true" or "false"
 	static PIString fromBool(const bool value) {return PIString(value ? "true" : "false");}
-	static PIString readableSize(long bytes) {PIString s; s.setReadableSize(bytes); return s;}
+	
+	//! \brief Return string contains human readable size in B/kB/MB/GB/TB
+	//! \details Example: \snippet pistring.cpp PIString::readableSize
+	static PIString readableSize(llong bytes) {PIString s; s.setReadableSize(bytes); return s;}
 
 private:
 	static const char toBaseN[];
@@ -254,45 +627,92 @@ private:
 	wstring convertToWString() const {wstring s; for (int i = 0; i < length(); ++i) s.push_back(at(i).toWChar()); return s;}
 #endif
 
-	PIByteArray data_;
+	mutable PIByteArray data_;
 	//string std_string;
 	//wstring std_wstring;
 
 };
 
+
+//! \relatesalso PIString \brief Output operator to std::ostream (cout)
 inline std::ostream & operator <<(std::ostream & s, const PIString & v) {for (int i = 0; i < v.length(); ++i) s << v[i]; return s;}
+
+//! \relatesalso PIString \brief Input operator from std::istream (cin)
 inline std::istream & operator >>(std::istream & s, PIString & v) {string ss; s >> ss; v << PIString(ss); return s;}
 
+//! \relatesalso PIString \relatesalso PICout \brief Output operator to PICout
+inline PICout operator <<(PICout s, const PIString & v) {s.space(); s.quote(); s.setControl(0, true); for (int i = 0; i < v.length(); ++i) s << v[i]; s.restoreControl(); s.quote(); return s;}
+
+
+//! \relatesalso PIString \relatesalso PIByteArray \brief Output operator to PIByteArray
 inline PIByteArray & operator <<(PIByteArray & s, const PIString & v) {s << v.size_s(); for (int i = 0; i < v.length(); ++i) s << v[i]; return s;}
+
+//! \relatesalso PIString \relatesalso PIByteArray \brief Input operator from PIByteArray
 inline PIByteArray & operator >>(PIByteArray & s, PIString & v) {int sz; s >> sz; v.resize(sz); for (int i = 0; i < sz; ++i) s >> v[i]; return s;}
 
+
+//! \relatesalso PIString \brief Return concatenated string
 inline PIString operator +(const PIString & str, const PIString & f) {PIString s(str); s += f; return s;}
 
 //inline PIString operator +(const PIString & f, const char c) {PIString s(f); s.push_back(c); return s;}
+
+//! \relatesalso PIString \brief Return concatenated string
 inline PIString operator +(const PIString & f, const char * str) {PIString s(f); s += str; return s;}
+
+//! \relatesalso PIString \brief Return concatenated string
 inline PIString operator +(const PIString & f, const string & str) {PIString s(f); s += str; return s;}
 
 //inline PIString operator +(const char c, const PIString & f) {return PIString(c) + f;}
+
+//! \relatesalso PIString \brief Return concatenated string
 inline PIString operator +(const char * str, const PIString & f) {return PIString(str) + f;}
+
+//! \relatesalso PIString \brief Return concatenated string
 inline PIString operator +(const string & str, const PIString & f) {return PIString(str) + f;}
 
 inline char chrUpr(char c);
 inline char chrLwr(char c);
 
-class PIStringList: public PIVector<PIString>
+
+/*!\brief Strings array class
+ * \details This class is based on \a PIVector<PIString> and
+ * expand it functionality. */
+class PIP_EXPORT PIStringList: public PIVector<PIString>
 {
 public:
+	
+	//! Contructs empty strings list
 	PIStringList() {;}
+	
+	//! Contructs strings list with one string "str"
 	PIStringList(const PIString & str) {push_back(str);}
+	
+	//! Contructs empty strings list with strings "s0" and "s1"
 	PIStringList(const PIString & s0, const PIString & s1) {push_back(s0); push_back(s1);}
+	
+	//! Contructs empty strings list with strings "s0", "s1" and "s2"
 	PIStringList(const PIString & s0, const PIString & s1, const PIString & s2) {push_back(s0); push_back(s1); push_back(s2);}
+	
+	//! Contructs empty strings list with strings "s0", "s1", "s2" and "s3"
 	PIStringList(const PIString & s0, const PIString & s1, const PIString & s2, const PIString & s3) {push_back(s0); push_back(s1); push_back(s2); push_back(s3);}
 
+	
+	//! \brief Join all strings in one with delimiter "delim" and return it
+	//! \details Example: \snippet pistring.cpp PIStringList::join
 	PIString join(const PIString & delim) const {PIString s; for (uint i = 0; i < size(); ++i) {s += at(i); if (i < size() - 1) s += delim;} return s;}
+	
+	//! \brief Remove all strings equal "value" and return this
+	//! \details Example: \snippet pistring.cpp PIStringList::removeStrings
 	PIStringList & removeStrings(const PIString & value) {for (uint i = 0; i < size(); ++i) {if (at(i) == value) {remove(i); --i;}} return *this;}
+	
 	PIStringList & remove(uint num) {PIVector<PIString>::remove(num); return *this;}
 	PIStringList & remove(uint num, uint count) {PIVector<PIString>::remove(num, count); return *this;}
+	
+	//! \brief Remove duplicated strings and return this
+	//! \details Example: \snippet pistring.cpp PIStringList::removeDuplicates
 	PIStringList & removeDuplicates();
+	
+	//! Return sum of lengths of all strings
 	uint contentSize() {uint s = 0; for (uint i = 0; i < size(); ++i) s += at(i).size(); return s;}
 
 	PIStringList & operator <<(const PIString & str) {push_back(str); return *this;}
@@ -308,6 +728,10 @@ public:
 
 };
 
+//! \relatesalso PIStringList \brief Output operator to std::ostream (cout)
 inline std::ostream & operator <<(std::ostream & s, const PIStringList & v) {s << "{"; for (uint i = 0; i < v.size(); ++i) {s << '\"' << v[i] << '\"'; if (i < v.size() - 1) s << ", ";} s << "}"; return s;}
 
+//! \relatesalso PIStringList \relatesalso PICout \brief Output operator to PICout
+inline PICout operator <<(PICout s, const PIStringList & v) {s.space(); s.setControl(0, true); s << "{"; for (uint i = 0; i < v.size(); ++i) {s << '\"' << v[i] << '\"'; if (i < v.size() - 1) s << ", ";} s << "}"; s.restoreControl(); return s;}
+
 #endif // PISTRING_H