doc ru

libs/main/core/pistringlist.h

@@ -1,6 +1,8 @@
-/*! \brief Strings array class
- * \details This class is based on \a PIDeque<PIString> and
- * expand it functionality. */
+/*! \file pistringlist.h
+ * \~\brief
+ * \~english Based on \a PIDeque<PIString> strings list
+ * \~russian Основанный на \a PIDeque<PIString> массив строк
+ */
 /*
 	PIP - Platform Independent Primitives
 	Strings array class
@@ -30,80 +32,108 @@ class PIP_EXPORT PIStringList: public PIDeque<PIString>
 {
 public:
 
-	//! Contructs empty strings list
+	//! \~english Contructs an empty strings list
+	//! \~russian Создает пустой список строк
 	PIStringList() {;}
 
-	~PIStringList() {;}
-
-	//! Contructs strings list with one string "str"
+	//! \~english Contructs strings list with one string "str"
+	//! \~russian Создает список строк с одной строкой "str"
 	PIStringList(const PIString & str) {push_back(str);}
 	PIStringList(PIString && str) {push_back(std::move(str));}
 
-	//! Contructs empty strings list with strings "s0" and "s1"
+	//! \~english Contructs strings list with strings "s0" and "s1"
+	//! \~russian Создает список строк со строками "s0" и "s1"
 	PIStringList(const PIString & s0, const PIString & s1) {push_back(s0); push_back(s1);}
 	PIStringList(PIString && s0, PIString && s1) {push_back(std::move(s0)); push_back(std::move(s1));}
 
-	//! Contructs empty strings list with strings "s0", "s1" and "s2"
+	//! \~english Contructs strings list with strings "s0", "s1" and "s2"
+	//! \~russian Создает список строк со строками "s0", "s1" и "s2"
 	PIStringList(const PIString & s0, const PIString & s1, const PIString & s2) {push_back(s0); push_back(s1); push_back(s2);}
 	PIStringList(PIString && s0, PIString && s1, PIString && s2) {push_back(std::move(s0)); push_back(std::move(s1)); push_back(std::move(s2));}
 
-	//! Contructs empty strings list with strings "s0", "s1", "s2" and "s3"
+	//! \~english Contructs strings list with strings "s0", "s1", "s2" and "s3"
+	//! \~russian Создает список строк со строками "s0", "s1", "s2" и "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);}
 	PIStringList(PIString && s0, PIString && s1, PIString && s2, PIString && s3) {push_back(std::move(s0)); push_back(std::move(s1)); push_back(std::move(s2)); push_back(std::move(s3));}
 
+	//! \~english Contructs strings list with strings "o"
+	//! \~russian Создает список строк со строками "o"
 	PIStringList(const PIStringList & o): PIDeque<PIString>(o) {}
 	PIStringList(PIStringList && o): PIDeque<PIString>(std::move(o)) {}
+
+	//! \~english Contructs strings list with strings "o"
+	//! \~russian Создает список строк со строками "o"
 	PIStringList(const PIVector<PIString> & o): PIDeque<PIString>() {resize(o.size()); for (uint i = 0; i < size(); ++i) (*this)[i] = o[i];}
+
+	//! \~english Contructs strings list with strings "o"
+	//! \~russian Создает список строк со строками "o"
 	PIStringList(const PIDeque<PIString> & o): PIDeque<PIString>() {resize(o.size()); for (uint i = 0; i < size(); ++i) (*this)[i] = o[i];}
 
-	//! Contructs strings list with std::initializer_list
+	//! \~english Contructs strings list with strings "init_list" in std::initializer_list format
+	//! \~russian Создает список строк со строками "init_list" в формате std::initializer_list
 	PIStringList(std::initializer_list<PIString> init_list): PIDeque<PIString>(init_list) {}
 
 
-	//! \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;}
+	//! \~english Join all strings in one with delimiter "delim" and returns it
+	//! \~russian Соединяет все строки в одну через разделитель "delim" и возвращает её
+	PIString join(const PIString & delim) const;
 
-	//! \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;}
+	//! \~english Remove all strings equal "value" and returns reference to this
+	//! \~russian Удаляет все строки равные "value" и возвращает ссылку на этот список строк
+	PIStringList & removeStrings(const PIString & value);
 
 	PIStringList & remove(uint num) {PIDeque<PIString>::remove(num); return *this;}
 	PIStringList & remove(uint num, uint count) {PIDeque<PIString>::remove(num, count); return *this;}
 
-	//! \brief Remove duplicated strings and return this
-	//! \details Example: \snippet pistring.cpp PIStringList::removeDuplicates
+	//! \~english Remove duplicated strings and returns reference to this
+	//! \~russian Удаляет все дублированные строки и возвращает ссылку на этот список строк
 	PIStringList & removeDuplicates();
 
-	//! \brief Trim all strings
-	//! \details Example: \snippet pistring.cpp PIString::trim
-	PIStringList & trim() {for (uint i = 0; i < size(); ++i) (*this)[i].trim(); return *this;}
+	//! \~english Trim all strings and returns reference to this
+	//! \~russian Подчищает у всех строк пробельные символы в начале и в конце и возвращает ссылку на этот список строк
+	PIStringList & trim();
 
-	//! Return sum of lengths of all strings
+	//! \~english Returns sum of lengths of all strings
+	//! \~russian Возвращает сумму длин всех строк
 	uint contentSize() {uint s = 0; for (uint i = 0; i < size(); ++i) s += at(i).size(); return s;}
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator ==(const PIStringList & o) const {if (size() != o.size()) return false; for (size_t i = 0; i < size(); ++i) if (o[i] != (*this)[i]) return false; return true;}
 
-	//! Compare operator
+	//! \~english Compare operator
+	//! \~russian Оператор сравнения
 	bool operator !=(const PIStringList & o) const {return !(o == (*this));}
 
+	//! \~english Assign operator
+	//! \~russian Оператор присваивания
 	PIStringList & operator =(const PIStringList & o) {PIDeque<PIString>::operator=(o); return *this;}
 
+	//! \~english Append string "str"
+	//! \~russian Добавляет строку "str"
 	PIStringList & operator <<(const PIString & str) {append(str); return *this;}
 	PIStringList & operator <<(PIString && str) {append(std::move(str)); return *this;}
+
+	//! \~english Append strings list "sl"
+	//! \~russian Добавляет список строк "sl"
 	PIStringList & operator <<(const PIStringList & sl) {append(sl); return *this;}
 
 };
 
 
-//! \relatesalso PIByteArray \brief Output operator to PIByteArray
+//! \relatesalso PIByteArray
+//! \~english Store operator
+//! \~russian Оператор сохранения
 inline PIByteArray & operator <<(PIByteArray & s, const PIStringList & v) {s << int(v.size_s()); for (int i = 0; i < v.size_s(); ++i) s << v[i]; return s;}
 
-//! relatesalso PIByteArray \brief Input operator from PIByteArray
+//! \relatesalso PIByteArray
+//! \~english Restore operator
+//! \~russian Оператор извлечения
 inline PIByteArray & operator >>(PIByteArray & s, PIStringList & v) {int sz; s >> sz; v.resize(sz); for (int i = 0; i < sz; ++i) s >> v[i]; return s;}
 
-//! \relatesalso PICout \brief Output operator to PICout
+//! \relatesalso PICout
+//! \~english Output operator to \a PICout
+//! \~russian Оператор вывода в \a 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 // PISTRINGLIST_H