merged AI doc, some new pages

libs/main/resources/piresources.h

@@ -1,9 +1,8 @@
-/*! \file piresources.h
- * \ingroup Resources
- * \~\brief
- * \~english Resources subsystem
- * \~russian Подсистема ресурсов
- */
+//! \~\file piresources.h
+//! \~\ingroup Resources
+//! \~\brief
+//! \~english Resources subsystem
+//! \~russian Подсистема ресурсов
 /*
     PIP - Platform Independent Primitives
     Resources subsystem
@@ -48,10 +47,8 @@
 //! \~\authors
 //! \~english
 //! Ivan Pelipenko peri4ko@yandex.ru;
-//! Andrey Bychkov work.a.b@yandex.ru;
 //! \~russian
 //! Иван Пелипенко peri4ko@yandex.ru;
-//! Андрей Бычков work.a.b@yandex.ru;
 //!
 
 #ifndef PIRESOURCES_H
@@ -59,18 +56,41 @@
 
 #include "pistring.h"
 
-#define INIT_RESOURCE(name)                 \
-	{                                       \
-		extern void _pirc_##name##_init_(); \
-		_pirc_##name##_init_();             \
-	}
+#ifdef DOXYGEN
 
+//! \~\ingroup Resources
+//! \relatesalso PIResources
+//! \~\brief
+//! \~english Registers a compiled resource module in the global storage.
+//! \~russian Регистрирует в глобальном хранилище модуль со вкомпиленными ресурсами.
+#  define INIT_RESOURCE(name)
+
+#else
+
+#  define INIT_RESOURCE(name)                 \
+	  {                                       \
+		  extern void _pirc_##name##_init_(); \
+		  _pirc_##name##_init_();             \
+	  }
+
+#endif
+
+//! \~\ingroup Resources
+//! \~\brief
+//! \~english Access to resources embedded into the application binary.
+//! \~russian Доступ к ресурсам, встроенным в бинарный файл приложения.
 class PIP_EXPORT PIResources {
 public:
-	//!
+	//! \~english Returns resource data from section `section` by entry name `name`.
+	//! \~russian Возвращает данные ресурса из секции `section` по имени элемента `name`.
 	static PIByteArray get(const PIString & section, const PIString & name);
+
+	//! \~english Returns first resource with name `name` across all registered sections.
+	//! \~russian Возвращает первый ресурс с именем `name` среди всех зарегистрированных секций.
 	static PIByteArray get(const PIString & name);
 
+	//! \~english Prints registered resource sections and entry sizes.
+	//! \~russian Печатает зарегистрированные секции ресурсов и размеры элементов.
 	static void dump();
 
 private: