merged AI doc, some new pages

libs/main/system/pisignals.h

@@ -1,9 +1,8 @@
-/*! \file pisignals.h
- * \ingroup System
- * \~\brief
- * \~english System signals
- * \~russian Сигналы системы
- */
+//! \~\file pisignals.h
+//! \~\ingroup System
+//! \~\brief
+//! \~english System signals
+//! \~russian Сигналы системы
 /*
     PIP - Platform Independent Primitives
     Signals
@@ -30,36 +29,57 @@
 
 #include <functional>
 
+//! \~\ingroup System
+//! \~\brief
+//! \~english Helper for installing process signal handlers.
+//! \~russian Вспомогательный класс для установки обработчиков сигналов процесса.
 class PIP_EXPORT PISignals {
 public:
+	//! \~english Supported process signals.
+	//! \~russian Поддерживаемые сигналы процесса.
 	enum Signal {
-		Interrupt /** Interrupt from keyboard */ = 0x01,    // Term Interrupt from keyboard
-		Illegal /** Illegal Instruction */       = 0x02,    // Core Illegal Instruction
-		Abort /** Abort signal */                = 0x04,    // Core Abort signal from abort
-		FPE /** Floating point exception */      = 0x08,    // Core Floating point exception
-		SegFault /** Invalid memory reference */ = 0x10,    // Core Invalid memory reference
-		Termination /** Termination signal */    = 0x20,    // Term Termination signal
-		Hangup                                   = 0x40,    // Term Hangup detected on controlling terminal or death of controlling process
-		Quit                                     = 0x80,    // Core Quit from keyboard
-		Kill                                     = 0x100,   // Term Kill signal
-		BrokenPipe                               = 0x200,   // Term Broken pipe: write to pipe with no readers
-		Timer                                    = 0x400,   // Term Timer signal from alarm
-		UserDefined1                             = 0x800,   // Term User-defined signal 1
-		UserDefined2                             = 0x1000,  // Term User-defined signal 2
-		ChildStopped                             = 0x2000,  // Ign  Child stopped or terminated
-		Continue                                 = 0x4000,  // Cont Continue if stopped
-		StopProcess                              = 0x8000,  // Stop Stop process
-		StopTTY                                  = 0x10000, // Stop Stop typed at tty
-		StopTTYInput                             = 0x20000, // Stop tty input for background process
-		StopTTYOutput                            = 0x40000, // Stop tty output for background process
-		All                                      = 0xFFFFF
+		Interrupt    = 0x01 /** \~english Interrupt from keyboard \~russian Прерывание с клавиатуры */,
+		Illegal      = 0x02 /** \~english Illegal instruction \~russian Недопустимая инструкция */,
+		Abort        = 0x04 /** \~english Abort signal \~russian Сигнал аварийного завершения */,
+		FPE          = 0x08 /** \~english Floating-point exception \~russian Исключение с плавающей точкой */,
+		SegFault     = 0x10 /** \~english Invalid memory reference \~russian Недопустимое обращение к памяти */,
+		Termination  = 0x20 /** \~english Termination request \~russian Запрос на завершение */,
+		Hangup       = 0x40 /** \~english Hangup on controlling terminal \~russian Разрыв управляющего терминала */,
+		Quit         = 0x80 /** \~english Quit from keyboard \~russian Завершение с клавиатуры */,
+		Kill         = 0x100 /** \~english Forced termination \~russian Принудительное завершение */,
+		BrokenPipe   = 0x200 /** \~english Write to a pipe without readers \~russian Запись в канал без читателей */,
+		Timer        = 0x400 /** \~english Alarm timer signal \~russian Сигнал таймера alarm */,
+		UserDefined1 = 0x800 /** \~english User-defined signal 1 \~russian Пользовательский сигнал 1 */,
+		UserDefined2 = 0x1000 /** \~english User-defined signal 2 \~russian Пользовательский сигнал 2 */,
+		ChildStopped = 0x2000 /** \~english Child process changed state \~russian Дочерний процесс изменил состояние */,
+		Continue     = 0x4000 /** \~english Continue a stopped process \~russian Продолжение остановленного процесса */,
+		StopProcess  = 0x8000 /** \~english Stop process execution \~russian Остановить выполнение процесса */,
+		StopTTY      = 0x10000 /** \~english Stop from terminal \~russian Остановка с терминала */,
+		StopTTYInput =
+			0x20000 /** \~english Background process requested terminal input \~russian Фоновый процесс запросил ввод с терминала */,
+		StopTTYOutput =
+			0x40000 /** \~english Background process requested terminal output \~russian Фоновый процесс запросил вывод в терминал */,
+		All = 0xFFFFF /** \~english Bit mask of all supported signals \~russian Битовая маска всех поддерживаемых сигналов */
 	};
 
+	//! \~english Callback invoked for each grabbed signal.
+	//! \~russian Обратный вызов, вызываемый для каждого перехваченного сигнала.
 	typedef std::function<void(PISignals::Signal)> SignalEvent;
-	// slot is any function format "void(PISignals::Signal)"
+
+	//! \~english Installs callback that receives grabbed signals.
+	//! \~russian Устанавливает обратный вызов, получающий перехваченные сигналы.
 	static void setSlot(SignalEvent slot) { ret_func = slot; }
+
+	//! \~english Redirects selected signals to the slot set by \a setSlot().
+	//! \~russian Перенаправляет выбранные сигналы в обработчик, заданный через \a setSlot().
 	static void grabSignals(PIFlags<PISignals::Signal> signals_);
+
+	//! \~english Restores default handlers for selected signals.
+	//! \~russian Восстанавливает обработчики по умолчанию для выбранных сигналов.
 	static void releaseSignals(PIFlags<PISignals::Signal> signals_);
+
+	//! \~english Raises the specified signal in the current process.
+	//! \~russian Посылает указанный сигнал текущему процессу.
 	static void raiseSignal(PISignals::Signal signal);
 
 private: