doc ru

libs/main/core/picli.h

@@ -1,5 +1,7 @@
 /*! \file picli.h
- * \brief Command-Line parser
+ * \~\brief
+ * \~english Command-Line parser
+ * \~russian Парсер командной строки
 */
 /*
 	PIP - Platform Independent Primitives
@@ -30,39 +32,54 @@ class PIP_EXPORT PICLI: public PIObject
 	PIOBJECT_SUBCLASS(PICLI, PIObject)
 public:
 	
-	//! Constructor
+	//! \~english Constructor
+	//! \~russian Конструктор
 	PICLI(int argc, char * argv[]);
 	
 	
-	//! Add argument with name "name", short key = name first letter, full key = name
+	//! \~english Add argument with name "name", short key = name first letter and full key = name
+	//! \~russian Добавляет аргумент с именем "name", коротким ключом = первой букве имени и полным ключом = имени
 	void addArgument(const PIString & name, bool value = false) {_args << Argument(name, name[0], name, value); needParse = true;}
 	
-	//! Add argument with name "name", short key = "shortKey", full key = name
+	//! \~english Add argument with name "name", short key = "shortKey" and full key = name
+	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = имени
 	void addArgument(const PIString & name, const PIChar & shortKey, bool value = false) {_args << Argument(name, shortKey, name, value); needParse = true;}
 	
-	//! Add argument with name "name", short key = "shortKey", full key = name
+	//! \~english Add argument with name "name", short key = "shortKey" and full key = name
+	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = имени
 	void addArgument(const PIString & name, const char * shortKey, bool value = false) {_args << Argument(name, PIChar(shortKey), name, value); needParse = true;}
 	
-	//! Add argument with name "name", short key = "shortKey", full key = "fullKey"
+	//! \~english Add argument with name "name", short key = "shortKey" and full key = "fullKey"
+	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = "fullKey"
 	void addArgument(const PIString & name, const PIChar & shortKey, const PIString & fullKey, bool value = false) {_args << Argument(name, shortKey, fullKey, value); needParse = true;}
 	
-	//! Add argument with name "name", short key = "shortKey", full key = "fullKey"
+	//! \~english Add argument with name "name", short key = "shortKey" and full key = "fullKey"
+	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = "fullKey"
 	void addArgument(const PIString & name, const char * shortKey, const PIString & fullKey, bool value = false) {_args << Argument(name, PIChar(shortKey), fullKey, value); needParse = true;}
 	
 	
-	//! Returns unparsed command-line argument by index "index". Index 0 is program execute command.
+	//! \~english Returns unparsed command-line argument by index "index". Index 0 is program execute command
+	//! \~russian Возвращает исходный аргумент командной строки по индексу "index". Индекс 0 это команда вызова программы
 	PIString rawArgument(int index) {parse(); return _args_raw[index];}
 	PIString mandatoryArgument(int index) {parse(); return _args_mand[index];}
 	PIString optionalArgument(int index) {parse(); return _args_opt[index];}
 	
-	//! Returns unparsed command-line arguments
+	//! \~english Returns unparsed command-line arguments
+	//! \~russian Возвращает исходные аргументы командной строки
 	const PIStringList & rawArguments() {parse(); return _args_raw;}
 	const PIStringList & mandatoryArguments() {parse(); return _args_mand;}
 	const PIStringList & optionalArguments() {parse(); return _args_opt;}
 	
-	//! Returns program execute command without arguments
+	//! \~english Returns program execute command without arguments
+	//! \~russian Возвращает команду вызова программы без аргументов
 	PIString programCommand() {parse(); return _args_raw.size() > 0 ? _args_raw.front() : PIString();}
+
+	//! \~english Returns if argument "name" found
+	//! \~russian Возвращает найден ли аргумент "name"
 	bool hasArgument(const PIString & name) {parse(); piForeach (Argument & i, _args) if (i.name == name && i.found) return true; return false;}
+
+	//! \~english Returns argument "name" value, or empty string if this is no value
+	//! \~russian Возвращает значение аргумента "name" или пустую строку, если значения нет
 	PIString argumentValue(const PIString & name) {parse(); piForeach (Argument &i, _args) if (i.name == name && i.found) return i.value; return PIString();}
 	PIString argumentShortKey(const PIString & name) {piForeach (Argument &i, _args) if (i.name == name) return i.short_key; return PIString();}
 	PIString argumentFullKey(const PIString & name) {piForeach (Argument &i, _args) if (i.name == name) return i.full_key; return PIString();}