merged AI doc, some new pages

libs/main/application/pilog.h

@@ -1,12 +1,11 @@
-/*! \file pilog.h
- * \ingroup Application
- * \~\brief
- * \~english High-level log
- * \~russian Высокоуровневый лог
- */
+//! \~\file pilog.h
+//! \~\ingroup Application
+//! \~\brief
+//! \~english High-level log
+//! \~russian Высокоуровневый лог
 /*
     PIP - Platform Independent Primitives
-	High-level log
+    High-level log
     Ivan Pelipenko peri4ko@yandex.ru
 
     This program is free software: you can redistribute it and/or modify
@@ -30,15 +29,23 @@
 #include "piiostream.h"
 #include "pithread.h"
 
-//! \ingroup Application
+//! \~\ingroup Application
 //! \~\brief
 //! \~english High-level log
 //! \~russian Высокоуровневый лог
+//! \~\details
+//! \~english Provides log with optional file and console output, with configurable timestamp format and line format.
+//! \~russian Предоставляет лог с опциональным выводом в файл и консоль, с настраиваемым форматом метки времени и форматом строки.
 class PIP_EXPORT PILog: public PIThread {
 	PIOBJECT_SUBCLASS(PILog, PIThread)
 
 public:
+	//! \~english Constructs log with console output, timestamped lines and rotated log files.
+	//! \~russian Создает лог с выводом в консоль, строками с метками времени и ротацией файлов.
 	PILog();
+
+	//! \~english Stops logging thread and flushes queued messages.
+	//! \~russian Останавливает поток логирования и дописывает сообщения из очереди.
 	~PILog();
 
 	//! \~english Message category
@@ -58,8 +65,8 @@ public:
 		All /** \~english All \~russian Все */             = 0xFF,
 	};
 
-	//! \~english Set output channel \"o\" to \"on\".
-	//! \~russian Установить канал вывода \"o\" в \"on\".
+	//! \~english Enables or disables output channel "o".
+	//! \~russian Включает или выключает канал вывода "o".
 	void setOutput(Output o, bool on = true) { output.setFlag(o, on); }
 
 	//! \~english Returns prefix for filename.
@@ -80,7 +87,7 @@ public:
 
 
 	//! \~english Returns directory for log files.
-	//! \~russian Возвращает директорию для файлов.
+	//! \~russian Возвращает директорию файлов лога.
 	PIString dir() const { return log_dir; }
 
 	//! \~english Set directory for log files. Should be set \b after \a setLogName()!
@@ -92,8 +99,8 @@ public:
 	//! \~russian Возвращает время жизни файла.
 	PISystemTime fileSplitTime() const { return split_time; }
 
-	//! \~english Set lifetime for file. Each "st" interval new file will be created.
-	//! \~russian Устанавливает время жизни файла. Каждый интервал "st" будет создан новый файл.
+	//! \~english Sets log file rotation interval. A new file is created every "st".
+	//! \~russian Устанавливает интервал ротации файла лога. Новый файл создается каждые "st".
 	void setFileSplitTime(PISystemTime st) { split_time = st; }
 
 
@@ -110,8 +117,8 @@ public:
 	//! \~russian Возвращает формат строки.
 	PIString lineFormat() const { return line_format; }
 
-	//! \~english Set line format. "t" is timestamp, "c" is category and "m" is message. Default is "t - c: m".
-	//! \~russian Устанавливает формат строки. "t" - метка времени, "c" - категория и "m" - сообщение. По умолчанию "t - c: m".
+	//! \~english Sets line format. "t" is timestamp, "c" is category and "m" is message. Default is "t - c: m".
+	//! \~russian Устанавливает формат строки. "t" - метка времени, "c" - категория, "m" - сообщение. По умолчанию "t - c: m".
 	void setLineFormat(const PIString & f);
 
 
@@ -119,9 +126,8 @@ public:
 	//! \~russian Возвращает максимальную категорию.
 	Level level() const { return max_level; }
 
-	//! \~english Set maximum level. All levels greater than \"l\" will be ignored. Default is \a Level::Debug.
-	//! \~russian Устанавливает максимальную категорию. Все сообщения с большей категорией, чем \"l\", будут игнорироваться. По умолчанию \a
-	//! Level::Debug.
+	//! \~english Sets maximum accepted level. Messages above "l" are ignored. Default is \a Level::Debug.
+	//! \~russian Устанавливает максимальный принимаемый уровень. Сообщения выше "l" игнорируются. По умолчанию \a Level::Debug.
 	void setLevel(Level l);
 
 	//! \~english Returns \a PICout for \a Level::Error level.
@@ -140,12 +146,12 @@ public:
 	//! \~russian Возвращает \a PICout для категории \a Level::Debug.
 	PICout debug(PIObject * context = nullptr);
 
-	//! \~english Write all queued lines and stop. Also called in destructor.
-	//! \~russian Записывает все строки из очереди и останавливается. Также вызывается в деструкторе.
+	//! \~english Writes all queued lines and stops logging. Also called from destructor.
+	//! \~russian Записывает все строки из очереди и останавливает логирование. Также вызывается из деструктора.
 	void stop();
 
-	//! \~english Read all previous and current log content and returns them as %PIStringList.
-	//! \~russian Читает все предыдущие и текущий логи и возвращает их как %PIStringList.
+	//! \~english Reads all rotated and current log lines and returns them as %PIStringList.
+	//! \~russian Читает строки из текущего и уже ротированных логов и возвращает их как %PIStringList.
 	PIStringList readAllLogs() const;
 
 private: