Document that GetUserDataDir() doesn't respect XDG file layout

And recommend using GetUserDir() instead.
This commit is contained in:
Vadim Zeitlin 2024-01-02 01:47:26 +01:00
parent 92b901f971
commit 420983f76a

View file

@ -376,11 +376,19 @@ public:
virtual wxString GetUserConfigDir() const;
/**
Return the directory for the user-dependent application data files:
Return the directory for the user-dependent application data files.
The returned path is:
- Unix: @c ~/.appinfo
- Windows: @c "C:\Users\username\AppData\Roaming\appinfo" or
@c "C:\Documents and Settings\username\Application Data\appinfo"
- Mac: @c "~/Library/Application Support/appinfo"
Please note that under Unix this function return value doesn't depend
on the file layout, and so returns a possibly unexpected value when
wxStandardPaths::FileLayout_XDG is used. Consider using GetUserDir()
instead if you use XDG layout, as this function does respect it.
*/
virtual wxString GetUserDataDir() const;