merged AI doc, some new pages

libs/main/application/picli.h

@@ -1,9 +1,8 @@
-/*! \file picli.h
- * \ingroup Application
- * \~\brief
- * \~english Command-Line parser
- * \~russian Парсер командной строки
- */
+//! \~\file picli.h
+//! \~\ingroup Application
+//! \brief
+//! \~english Command-line argument parser
+//! \~russian Парсер аргументов командной строки
 /*
     PIP - Platform Independent Primitives
     Command-Line Parser
@@ -29,10 +28,15 @@
 #include "piset.h"
 #include "pistringlist.h"
 
-//! \ingroup Application
+//! \~\ingroup Application
 //! \~\brief
-//! \~english Command-Line parser.
-//! \~russian Парсер командной строки.
+//! \~english Command-line argument parser class
+//! \~russian Класс парсера аргументов командной строки
+//! \details
+//! \~english The PICLI class provides convenient parsing of command-line arguments. It supports short keys (e.g., -c), full keys (e.g.,
+//! --console), and arguments with/without values.
+//! \~russian Класс PICLI предоставляет удобный разбор аргументов командной строки. Поддерживаются короткие ключи (например, -c), полные
+//! ключи (например, --console) и аргументы с значениями/без значений.
 class PIP_EXPORT PICLI {
 public:
 	//! \~english Constructs %PICLI from "argc" and "argv" from "int main()" method.
@@ -64,13 +68,25 @@ public:
 	//! \~english Returns unparsed command-line argument by index "index". Index 0 is program execute command.
 	//! \~russian Возвращает исходный аргумент командной строки по индексу "index". Индекс 0 это команда вызова программы.
 	PIString rawArgument(int index);
+
+	//! \~english Returns mandatory positional argument by index.
+	//! \~russian Возвращает обязательный позиционный аргумент по индексу.
 	PIString mandatoryArgument(int index);
+
+	//! \~english Returns optional positional argument by index.
+	//! \~russian Возвращает необязательный позиционный аргумент по индексу.
 	PIString optionalArgument(int index);
 
 	//! \~english Returns unparsed command-line arguments.
 	//! \~russian Возвращает исходные аргументы командной строки.
 	const PIStringList & rawArguments();
+
+	//! \~english Returns all mandatory positional arguments.
+	//! \~russian Возвращает все обязательные позиционные аргументы.
 	const PIStringList & mandatoryArguments();
+
+	//! \~english Returns all optional positional arguments.
+	//! \~russian Возвращает все необязательные позиционные аргументы.
 	const PIStringList & optionalArguments();
 
 	//! \~english Returns program execute command without arguments.
@@ -93,18 +109,52 @@ public:
 	//! \~russian Возвращает полный ключ аргумента "name" или пустую строку, если аргумента нет.
 	PIString argumentFullKey(const PIString & name);
 
+	//! \~english Returns prefix used for short keys.
+	//! \~russian Возвращает префикс коротких ключей.
 	const PIString & shortKeyPrefix() const { return _prefix_short; }
+
+	//! \~english Returns prefix used for full keys.
+	//! \~russian Возвращает префикс полных ключей.
 	const PIString & fullKeyPrefix() const { return _prefix_full; }
+
+	//! \~english Returns expected count of mandatory positional arguments.
+	//! \~russian Возвращает ожидаемое количество обязательных позиционных аргументов.
 	int mandatoryArgumentsCount() const { return _count_mand; }
+
+	//! \~english Returns expected count of optional positional arguments.
+	//! \~russian Возвращает ожидаемое количество необязательных позиционных аргументов.
 	int optionalArgumentsCount() const { return _count_opt; }
+
+	//! \~english Sets prefix used for short keys such as "-d".
+	//! \~russian Устанавливает префикс коротких ключей, например "-d".
 	void setShortKeyPrefix(const PIString & prefix);
+
+	//! \~english Sets prefix used for full keys such as "--debug".
+	//! \~russian Устанавливает префикс полных ключей, например "--debug".
 	void setFullKeyPrefix(const PIString & prefix);
+
+	//! \~english Sets count of mandatory positional arguments collected before optional ones.
+	//! \~russian Устанавливает количество обязательных позиционных аргументов, собираемых до необязательных.
 	void setMandatoryArgumentsCount(const int count);
+
+	//! \~english Sets count of optional positional arguments. Negative value means unlimited.
+	//! \~russian Устанавливает количество необязательных позиционных аргументов. Отрицательное значение означает без ограничения.
 	void setOptionalArgumentsCount(const int count);
 
+	//! \~english Returns debug mode flag.
+	//! \~russian Возвращает флаг режима отладки.
 	bool debug() const { return debug_; }
+
+	//! \~english Enables or disables debug mode.
+	//! \~russian Включает или выключает режим отладки.
 	void setDebug(bool debug) { debug_ = debug; }
+
+	//! \~english Returns class name.
+	//! \~russian Возвращает имя класса.
 	PIConstChars className() const { return "PICLI"; }
+
+	//! \~english Returns human-readable object name.
+	//! \~russian Возвращает читаемое имя объекта.
 	PIString name() const { return PIStringAscii("CLI"); }
 
 private: