Annotate deprecated functions as such

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

diff --git a/source/fs/dir.h b/source/fs/dir.h
index d62df8cde781896d30fc64a1f99091fa22c3fcef..89d86ed9383c0f99661d80d1b169d82c87a2a585 100644 (file)
--- a/source/fs/dir.h
+++ b/source/fs/dir.h
@@ -4,6 +4,7 @@
 #include <list>
 #include <stdexcept>
 #include <string>
+#include <msp/core/attributes.h>
 #include "path.h"
 
 namespace Msp {
@@ -37,32 +38,36 @@ std::list<std::string> list_filtered(const Path &path, const std::string &filter
 /// Returns the current working directory
 Path getcwd();
 
+/// Changes the current working directory
+void chdir(const Path &);
+
 /// Returns the user's home directory
 Path get_home_dir();
 
-/// Returns a directory suitable for storing user-specific data
-Path get_user_data_dir(const std::string &appname);
+/// Deprecated.  Use the argument-less version instead.
+DEPRECATED 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
-Path get_sys_conf_dir(const std::string &argv0);
+/// Deprecated.  Use the argument-less version instead.
+DEPRECATED 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
-Path get_sys_data_dir(const std::string &argv0, const std::string &appname);
+/// Deprecated.  Use the argument-less version instead.
+DEPRECATED 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
-Path get_sys_lib_dir(const std::string &argv0, const std::string &appname);
+/// Deprecated.  Use the argument-less version instead.
+DEPRECATED 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
-void chdir(const Path &);
-
 /** Looks for a file in a list of paths.  Returns the absolute path to the
 first existing location, or an empty Path if the file is not found at all. */
 Path path_lookup(const std::string &, const std::list<Path> &);