add doxygen via opencode

libs/main/resources/piresources.h

@@ -22,12 +22,15 @@
     You should have received a copy of the GNU Lesser General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+//! \~english Resources subsystem
+//! \~russian Подсистема ресурсов
 //! \defgroup Resources Resources
 //! \~\brief
 //! \~english Resources subsystem
 //! \~russian Подсистема ресурсов
 //!
 //! \~\details
+//! \~
 //! \~english \section cmake_module_Resources Building with CMake
 //! \~russian \section cmake_module_Resources Сборка с использованием CMake
 //!
@@ -59,18 +62,31 @@
 
 #include "pistring.h"
 
-#define INIT_RESOURCE(name)                 \
-	{                                       \
-		extern void _pirc_##name##_init_(); \
-		_pirc_##name##_init_();             \
-	}
+//! \~english Macro for initializing compiled-in resources
+//! \~russian Макрос для инициализации вкомпиленных ресурсов
+#define INIT_RESOURCE(name)             \
+  {                                     \
+	extern void _pirc_##name##_init_(); \
+	_pirc_##name##_init_();             \
+  }
 
+//! \~english Class for accessing compiled-in resources
+//! \~russian Класс для доступа к вкомпиленным ресурсам
 class PIP_EXPORT PIResources {
 public:
-	//!
+	//! \~english Get resource by section and name
+	//! \~russian Получить ресурс по секции и имени
+	//! \details
+	//! \~english Searches for resource in specified section
+	//! \~russian Ищет ресурс в указанной секции
 	static PIByteArray get(const PIString & section, const PIString & name);
+
+	//! \~english Get resource by name (searches all sections)
+	//! \~russian Получить ресурс по имени (ищет во всех секциях)
 	static PIByteArray get(const PIString & name);
 
+	//! \~english Dump all resources to console
+	//! \~russian Вывести все ресурсы в консоль
 	static void dump();
 
 private:

libs/main/resources/piresourcesstorage.h

@@ -17,6 +17,13 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+//! \~english Resources storage subsystem
+//! \~russian Подсистема хранения ресурсов
+//! \defgroup Resources Resources
+//! \~\brief
+//! \~english Resources storage subsystem
+//! \~russian Подсистема хранения ресурсов
+
 #ifndef PIRESOURCES_P_H
 #define PIRESOURCES_P_H
 
@@ -26,17 +33,36 @@
 
 class PIResources;
 
+//! \~english Storage for compiled-in resources
+//! \~russian Хранилище вкомпиленных ресурсов
 class PIP_EXPORT PIResourcesStorage {
 	friend class PIResources;
 
 public:
+	//! \~english Get singleton instance
+	//! \~russian Получить синглтон
 	static PIResourcesStorage * instance();
 
+	//! \~english Section containing resource entries
+	//! \~russian Секция, содержащая записи ресурсов
 	struct PIP_EXPORT Section {
+		//! \~english Constructor
+		//! \~russian Конструктор
 		Section();
+		//! \~english Destructor
+		//! \~russian Деструктор
 		~Section();
+
+		//! \~english Add another section to this one
+		//! \~russian Добавить другую секцию к этой
 		void add(const Section & s);
+
+		//! \~english Clear all entries
+		//! \~russian Очистить все записи
 		void purge();
+
+		//! \~english Map of resource names to data
+		//! \~russian Карта имен ресурсов к данным
 		PIMap<PIString, PIByteArray *> entries;
 	};
 
@@ -56,21 +82,65 @@ public:
 			size    = si;
 			flags   = fl;
 		}
+
+		//! \~english Section name
+		//! \~russian Имя секции
 		PIString section;
+
+		//! \~english Resource name
+		//! \~russian Имя ресурса
 		PIString name;
+
+		//! \~english Alias
+		//! \~russian Псевдоним
 		PIString alias;
+
+		//! \~english Source file
+		//! \~russian Исходный файл
 		PIString file;
+
+		//! \~english Offset in file
+		//! \~russian Смещение в файле
 		llong offset;
+
+		//! \~english Size
+		//! \~russian Размер
 		llong size;
+
+		//! \~english Flags
+		//! \~russian Флаги
 		int flags;
 	};
 
+	//! \~english Register a section with data
+	//! \~russian Зарегистрировать секцию с данными
+	//! \param section_name Name of the section
+	//! \param data Section data
 	void registerSection(const PIString & section_name, const Section & data);
+
+	//! \~english Register from raw data
+	//! \~russian Зарегистрировать из сырых данных
+	//! \param rc_data Resource data
+	//! \param rc_desc Resource description
+	//! \param rc_desc_size Description size
 	void registerSection(const uchar * rc_data, const uchar * rc_desc, int rc_desc_size);
+
+	//! \~english Get section by name
+	//! \~russian Получить секцию по имени
+	//! \param section_name Name of section
+	//! \return Pointer to section or nullptr
 	Section * section(const PIString & section_name) const;
+
+	//! \~english Get resource by section and name
+	//! \~russian Получить ресурс по секции и имени
 	PIByteArray get(const PIString & section_name, const PIString & entry_name) const;
+
+	//! \~english Get resource by name (searches all sections)
+	//! \~russian Получить ресурс по имени (ищет во всех секциях)
 	PIByteArray get(const PIString & entry_name) const;
 
+	//! \~english Clear all sections
+	//! \~russian Очистить все секции
 	void clear();
 
 private: