doc core reference done

libs/main/core/picli.h

@@ -37,56 +37,62 @@ class PIP_EXPORT PICLI
 {
 public:
 	
-	//! \~english Constructor
-	//! \~russian Конструктор
+	//! \~english Constructs %PICLI from "argc" and "argv" from "int main()" method.
+	//! \~russian Создает %PICLI из "argc" и "argv" из метода "int main()".
 	PICLI(int argc, char * argv[]);
 	
 	
-	//! \~english Add argument with name "name", short key = name first letter and full key = name
-	//! \~russian Добавляет аргумент с именем "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;}
 	
-	//! \~english Add argument with name "name", short key = "shortKey" and full key = name
-	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = имени
+	//! \~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;}
 	
-	//! \~english Add argument with name "name", short key = "shortKey" and full key = name
-	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = имени
+	//! \~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;}
 	
-	//! \~english Add argument with name "name", short key = "shortKey" and full key = "fullKey"
-	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = "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;}
 	
-	//! \~english Add argument with name "name", short key = "shortKey" and full key = "fullKey"
-	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = "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;}
 	
 	
-	//! \~english Returns unparsed command-line argument by index "index". Index 0 is program execute command
-	//! \~russian Возвращает исходный аргумент командной строки по индексу "index". Индекс 0 это команда вызова программы
+	//! \~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];}
 	
-	//! \~english Returns unparsed command-line arguments
-	//! \~russian Возвращает исходные аргументы командной строки
+	//! \~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;}
 	
-	//! \~english Returns program execute command without arguments
-	//! \~russian Возвращает команду вызова программы без аргументов
+	//! \~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"
+	//! \~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" или пустую строку, если значения нет
+	//! \~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();}
+
+	//! \~english Returns short key of argument "name", or empty string if this is no argument.
+	//! \~russian Возвращает короткий ключ аргумента "name" или пустую строку, если аргумента нет.
 	PIString argumentShortKey(const PIString & name) {piForeach (Argument &i, _args) if (i.name == name) return i.short_key; return PIString();}
+
+	//! \~english Returns full key of argument "name", or empty string if this is no argument.
+	//! \~russian Возвращает полный ключ аргумента "name" или пустую строку, если аргумента нет.
 	PIString argumentFullKey(const PIString & name) {piForeach (Argument &i, _args) if (i.name == name) return i.full_key; return PIString();}
 	
 	const PIString & shortKeyPrefix() const {return _prefix_short;}