Deprecate the system directory accessors that take arguments

[libs/core.git] / source / fs / dir.h

diff --git a/source/fs/dir.h b/source/fs/dir.h
index d62df8cde781896d30fc64a1f99091fa22c3fcef..cf2cdeb79c97437f86a7e8ffb4f5bc158aa2c8e8 100644 (file)
--- a/source/fs/dir.h
+++ b/source/fs/dir.h
@@ -40,24 +40,28 @@ Path getcwd();
 /// Returns the user's home directory
 Path get_home_dir();
 
-/// Returns a directory suitable for storing user-specific data
+/// Deprecated.  Use the argument-less version instead.
 Path get_user_data_dir(const std::string &appname);
 
+/// Returns a directory suitable for storing user-specific data.
 Path get_user_data_dir();
 
-/// Returns a directory containing system-wide configuration
+/// Deprecated.  Use the argument-less version instead.
 Path get_sys_conf_dir(const std::string &argv0);
 
+/// Returns a directory containing system-wide configuration.
 Path get_sys_conf_dir();
 
-/// Returns a directory containing immutable system-wide data
+/// Deprecated.  Use the argument-less version instead.
 Path get_sys_data_dir(const std::string &argv0, const std::string &appname);
 
+/// Returns a directory containing immutable system-wide data.
 Path get_sys_data_dir();
 
-/// Returns a directory containing system-wide architecture-specific files
+/// Deprecated.  Use the argument-less version instead.
 Path get_sys_lib_dir(const std::string &argv0, const std::string &appname);
 
+/// Returns a directory containing system-wide architecture-specific files.
 Path get_sys_lib_dir();
 
 /// Changes the current working directory