doc ru

libs/main/core/pichar.h

@@ -1,5 +1,7 @@
 /*! \file pichar.h
- * \brief Unicode char
+ * \~\brief
+ * \~english Single string character
+ * \~russian Один символ строки
 */
 /*
 	PIP - Platform Independent Primitives
@@ -34,97 +36,134 @@ class PIP_EXPORT PIChar
 	friend class PIString;
 	friend PICout PIP_EXPORT operator <<(PICout s, const PIChar & v);
 public:
-	//! Contructs ascii symbol
+	//! \~english Contructs Ascii symbol
+	//! \~russian Создает символ Ascii
 	PIChar(const char c) {ch = c; ch &= 0xFF;}
 
-	//! Contructs 2-bytes symbol
+	//! \~english Contructs 2-bytes symbol
+	//! \~russian Создает 2-байтный символ
 	PIChar(const short c) {ch = c;}
 
-	//! Contructs 4-bytes symbol
-	PIChar(const int c) {ch = c;}
+	//! \~english Contructs ascii symbol
+	//! \~russian Создает символ Ascii
+	PIChar(const uchar c) {ch = c;}
 
-	//! Contructs ascii symbol
-	PIChar(const uchar c) {ch = c; ch &= 0xFF;}
+	//! \~english Contructs 2-bytes symbol
+	//! \~russian Создает 2-байтный символ
+	PIChar(const ushort c = 0) {ch = c;}
 
-	//! Contructs 2-bytes symbol
-	PIChar(const ushort c) {ch = c;}
-
-	//! Default constructor. Contructs 4-bytes symbol
-	PIChar(const uint c = 0) {ch = c;}
-
-	//! Contructs symbol from no more than 4 bytes of string
+	//! \~english Contructs symbol from system locale and no more than 4 bytes of string
+	//! \~russian Создает символ из системной локали не более 4 байт длины
 	PIChar(const char * c, int * bytes = 0);
 
-	//! Copy operator
+	//! \~english Copy operator
+	//! \~russian Оператор присваивания
 	PIChar & operator =(const char v) {ch = v; return *this;}
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator ==(const PIChar & o) const;
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator !=(const PIChar & o) const {return !(o == *this);}
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator >(const PIChar & o) const;
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator <(const PIChar & o) const;
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator >=(const PIChar & o) const;
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator <=(const PIChar & o) const;
 
-	//! Return \b true if symbol is digit ('0' to '9')
+	//! \~english Returns \b true if symbol is digit ('0' to '9')
+	//! \~russian Возвращает \b true если символ является
 	bool isDigit() const;
 	
-	//! Return \b true if symbol is HEX digit ('0' to '9', 'a' to 'f', 'A' to 'F')
+	//! \~english Returns \b true if symbol is HEX digit ('0' to '9', 'a' to 'f', 'A' to 'F')
+	//! \~russian Возвращает \b true если символ является HEX цифрой ('0' до '9', 'a' до 'f', 'A' до 'F')
 	bool isHex() const;
 	
-	//! Return \b true if symbol is drawable (without space)
+	//! \~english Returns \b true if symbol is drawable (without space)
+	//! \~russian Возвращает \b true если символ является графическим (исключая пробельные)
 	bool isGraphical() const;
 	
-	//! Return \b true if symbol is control byte (< 32 or 127)
+	//! \~english Returns \b true if symbol is control byte (< 32 or 127)
+	//! \~russian Возвращает \b true если символ является контрольным (< 32 or 127)
 	bool isControl() const;
 	
-	//! Return \b true if symbol is in lower case
+	//! \~english Returns \b true if symbol is in lower case
+	//! \~russian Возвращает \b true если символ в нижнем регистре
 	bool isLower() const;
-	
-	//! Return \b true if symbol is in upper case
+
+	//! \~english Returns \b true if symbol is in upper case
+	//! \~russian Возвращает \b true если символ в верхнем регистре
 	bool isUpper() const;
 	
-	//! Return \b true if symbol is printable (with space)
+	//! \~english Returns \b true if symbol is printable (with space)
+	//! \~russian Возвращает \b true если символ является печатным (включая пробельные)
 	bool isPrint() const;
 	
-	//! Return \b true if symbol is space or tab
+	//! \~english Returns \b true if symbol is space or tab
+	//! \~russian Возвращает \b true если символ является пробельным или табуляцией
 	bool isSpace() const;
 	
-	//! Return \b true if symbol is alphabetical letter
+	//! \~english Returns \b true if symbol is alphabetical letter
+	//! \~russian Возвращает \b true если символ является алфавитной буквой
 	bool isAlpha() const;
 	
-	//! Return \b true if symbol is ascii (< 128)
+	//! \~english Returns \b true if symbol is Ascii (< 128)
+	//! \~russian Возвращает \b true если символ является Ascii (< 128)
 	bool isAscii() const;
 
 	const wchar_t * toWCharPtr() const;
 	
-	//! Return as <tt>"char * "</tt> string
+	//! \~english Returns as <tt>"char * "</tt> string
+	//! \~russian Возвращает символ как указатель на <tt>"char * "</tt>
 	const char * toCharPtr() const;
 	
 	wchar_t toWChar() const;
+
+	//! \~english Returns symbol as Ascii
+	//! \~russian Возвращает символ в Ascii
 	char toAscii() const {return ch % 256;}
+
+	//! \~english Returns symbol as console codepage
+	//! \~russian Возвращает символ в консольной кодировке
 	char toConsole1Byte() const;
+
+	//! \~english Returns symbol as system codepage
+	//! \~russian Возвращает символ в системной кодировке
 	char toSystem() const;
+
 	ushort unicode16Code() const {return ch;}
 	
-	//! Return symbol in upper case
+	//! \~english Returns symbol in upper case
+	//! \~russian Возвращает символ в нижнем регистре
 	PIChar toUpper() const;
 	
-	//! Return symbol in lower case
+	//! \~english Returns symbol in lower case
+	//! \~russian Возвращает символ в верхнем регистре
 	PIChar toLower() const;
 	
+	//! \~english Returns symbol from console codepage
+	//! \~russian Возвращает символ из консольной кодировки
 	static PIChar fromConsole(char c);
+
+	//! \~english Returns symbol from system codepage
+	//! \~russian Возвращает символ из системной кодировки
 	static PIChar fromSystem(char c);
+
+	//! \~english Returns symbol from UTF8 codepage
+	//! \~russian Возвращает символ из UTF8 кодировки
 	static PIChar fromUTF8(const char * c);
 
 private:
@@ -132,54 +171,86 @@ private:
 
 };
 
-//! Output operator to \a PICout
+//! \relatesalso PIChar
+//! \~english Output operator to \a PICout
+//! \~russian Оператор вывода в \a PICout
 PICout PIP_EXPORT operator <<(PICout s, const PIChar & v);
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator ==(const char v, const PIChar & c) {return (PIChar(v) == c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator >(const char v, const PIChar & c) {return (PIChar(v) > c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator <(const char v, const PIChar & c) {return (PIChar(v) < c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator >=(const char v, const PIChar & c) {return (PIChar(v) >= c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator <=(const char v, const PIChar & c) {return (PIChar(v) <= c);}
 
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator ==(const char * v, const PIChar & c) {return (PIChar(v) == c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator >(const char * v, const PIChar & c) {return (PIChar(v) > c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator <(const char * v, const PIChar & c) {return (PIChar(v) < c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator >=(const char * v, const PIChar & c) {return (PIChar(v) >= c);}
 
-//! Compare operator
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
 inline bool operator <=(const char * v, const PIChar & c) {return (PIChar(v) <= c);}
 
 
-//! Compare operator
-inline bool operator ==(const int v, const PIChar & c) {return (PIChar(v) == c);}
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
+inline bool operator ==(const int v, const PIChar & c) {return (PIChar((ushort)v) == c);}
 
-//! Compare operator
-inline bool operator >(const int v, const PIChar & c) {return (PIChar(v) > c);}
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
+inline bool operator >(const int v, const PIChar & c) {return (PIChar((ushort)v) > c);}
 
-//! Compare operator
-inline bool operator <(const int v, const PIChar & c) {return (PIChar(v) < c);}
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
+inline bool operator <(const int v, const PIChar & c) {return (PIChar((ushort)v) < c);}
 
-//! Compare operator
-inline bool operator >=(const int v, const PIChar & c) {return (PIChar(v) >= c);}
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
+inline bool operator >=(const int v, const PIChar & c) {return (PIChar((ushort)v) >= c);}
 
-//! Compare operator
-inline bool operator <=(const int v, const PIChar & c) {return (PIChar(v) <= c);}
+//! \relatesalso PIChar
+//! \~english Compare operator
+//! \~russian Оператор сравнения
+inline bool operator <=(const int v, const PIChar & c) {return (PIChar((ushort)v) <= c);}
 
 #endif // PICHAR_H