f1x1t/myxlib
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Правка документации

Browse Source
This commit is contained in:
Andrei Astafev 2020-04-13 09:26:13 +03:00
parent 307437caee
commit 7c2e583cb7
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/myx/filesystem/paths.hpp
View File

@ -24,20 +24,20 @@ class Paths
enum class HierarchyType : intptr_t
{
/// @brief Тип расположения файлов не определён
kUndefined = 0x00,
kUndefined = 0x00,
/// @brief Не определено ни одно из типовых размещений файлов
/// @details Если исполняемый файл не находится в каталоге bin или не найдены
/// необходимые сопутствующие каталоги, то предполается,
/// что все файлы находятся в одном каталоге с исполняемым файлом
kFlat = 0x01,
kFlat = 0x01,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /opt
kOpt = 0x02,
kOpt = 0x02,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr
kUsr = 0x04,
kUsr = 0x04,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr/local
kUsrLocal = 0x08,
kUsrLocal = 0x08,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /home
kHome = 0x10,
kHome = 0x10,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в каталоге программного проекта
kDevelopment = 0x20
};
@ -124,22 +124,22 @@ public:
QString findConfigFile( const QString& defaultConfigFile = QLatin1String("") );
/**
* @brief Получение пути к базовому каталогу
* @brief Полный путь к базовому каталогу
*/
const QDir& prefixDirectory() const;
/**
* @brief Получение пути к каталогу с исполняемым файлом
* @brief Полный путь к каталогу с исполняемым файлом
*/
QDir binaryDirectory() const;
/**
* @brief Получение пути к пользовательскому каталогу с файлами настройки
* @brief Полный путь к пользовательскому каталогу с файлами настройки
*/
const QDir& userConfigDirectory() const;
/**
* @brief Получение пути к системному каталогу с файлами настройки
* @brief Полный путь к системному каталогу с файлами настройки
*/
const QDir& systemConfigDirectory() const;
@ -159,42 +159,42 @@ public:
const QString& configFileExtension() const;
/**
* @brief Получение пути к пользовательскому каталогу с изменяемыми файлами
* @brief Полный путь к пользовательскому каталогу с изменяемыми файлами
*/
const QDir& userVarDataDirectory() const;
/**
* @brief Получение пути к системному каталогу с изменяемыми файлами
* @brief Полный путь к системному каталогу с изменяемыми файлами
*/
const QDir& systemVarDataDirectory() const;
/**
* @brief Получение пути к пользовательскому каталогу с неизменяемыми файлами
* @brief Полный путь к пользовательскому каталогу с неизменяемыми файлами
*/
const QDir& userConstDataDirectory() const;
/**
* @brief Получение пути к системному каталогу с неизменяемыми файлами
* @brief Полный путь к системному каталогу с неизменяемыми файлами
*/
const QDir& systemConstDataDirectory() const;
/**
* @brief Получение пути к пользовательскому каталогу с журналами работы
* @brief Полный путь к пользовательскому каталогу с журналами работы
*/
const QDir& userLogDirectory() const;
/**
* @brief Получение пути к системному каталогу с журналами работы
* @brief Полный путь к системному каталогу с журналами работы
*/
const QDir& systemLogDirectory() const;
/**
* @brief Получение пути к каталогу с временными файлами
* @brief Полный путь к каталогу с временными файлами
*/
const QDir& tempDirectory() const;
/**
* @brief Получение пути к домашнему каталогу текущего пользователя
* @brief Полный путь к домашнему каталогу текущего пользователя
*/
const QDir& homeDirectory() const;