generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-11-01 21:13:10 +01:00
Code Issues Projects Releases Wiki Activity

update class documentation for Util::SystemConfiguration and Util::Application

Browse Source
This commit is contained in:
Björn Schramke
2015-01-28 16:12:39 +01:00
committed by Alex Fabijanic
parent 43c44aacbb
commit fe313fa278
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Util/include/Poco/Util/Application.h
View File

@@ -74,7 +74,10 @@ class Util_API Application: public Subsystem
/// - application.name: the file name of the application executable
/// - application.baseName: the file name (excluding extension) of the application executable
/// - application.dir: the path to the directory where the application executable resides
/// - application.configDir: the path to the directory where the last configuration file loaded with loadConfiguration() was found.
/// - application.configDir: the path to the directory where user specific configuration files of the application should be stored.
/// - application.cacheDir: the path to the directory where user specific non-essential data files of the application should be stored.
/// - application.dataDir: the path to the directory where user specific data files of the application should be stored.
/// - application.tempDir: the path to the directory where user specific temporary files and other file objects of the application should be stored.
///
/// If loadConfiguration() has never been called, application.configDir will be equal to application.dir.
///

2
Util/include/Poco/Util/SystemConfiguration.h
View File

@@ -42,7 +42,9 @@ class Util_API SystemConfiguration: public AbstractConfiguration
/// - system.configHomeDir: the base directory relative to which user specific configuration files should be stored
/// - system.cacheHomeDir: the base directory relative to which user specific non-essential data files should be stored
/// - system.dataHomeDir: the base directory relative to which user specific data files should be stored
/// - system.tempHomeDir: the base directory relative to which user-specific temporary files and other file objects should be placed
/// - system.tempDir: the system's temporary directory
/// - system.configDir: the system's configuration directory
/// - system.dateTime: the current UTC date and time, formatted in ISO 8601 format.
/// - system.pid: the current process ID.
/// - system.env.<NAME>: the environment variable with the given <NAME>.