Документация

src/myx/filesystem/current_executable.hpp

@@ -1,3 +1,8 @@
+/**
+  * @file current_executable.hpp
+  * @brief Параметры исполняемового файла
+  */
+
 #ifndef MYX_FILESYSTEM_CURRENT_EXECUTABLE_HPP_
 #define MYX_FILESYSTEM_CURRENT_EXECUTABLE_HPP_
 
@@ -11,17 +16,34 @@ namespace filesystem {
 
 class CurrentExecutable
 {
+	/// Путь к символической ссылке, указывающей на текущий исполняемый файл
 	QFileInfo m_procFilePath;
+	/// Канонический путь к текущему исполняемому файлу
 	QFileInfo m_canonicalFilePath;
-	QDir      m_canonicalPath;
-	QString   m_fileName;
+	/// Канонический путь к каталогу с текущим исполняемым файлом
+	QDir m_canonicalPath;
+	/// Имя текущего исполняемого файла
+	QString m_fileName;
 
 public:
+	/**
+	 * @brief Конструктор, собирающий информацию о текущем исполняемом файле.
+	 *        Иницализируются все внутренние переменные.
+	 */
 	CurrentExecutable();
+	/**
+	 * @brief Канонический путь к текущему исполняемому файлу
+	 */
 	QFileInfo canonicalFilePath() const;
+	/**
+	 * @brief Канонический путь к каталогу с текущим исполняемым файлом
+	 */
 	QDir canonicalPath() const;
+	/**
+	 * @brief Имя текущего исполняемого файла
+	 */
 	QString fileName() const;
-};
+}; // class CurrentExecutable
 
 } // namespace filesystem