From ed80d9cef0c321012c65c31104be66dc64bf2fad Mon Sep 17 00:00:00 2001
From: Matthias Melcher <git@matthiasm.com>
Date: Tue, 14 Jan 2020 19:21:58 +0100
Subject: Fixed some documentation for Fl_Preferences and fl_make_path.

---
 FL/Fl_Preferences.H | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)

(limited to 'FL/Fl_Preferences.H')

diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H
index 45717265a..eff8e1aae 100644
--- a/FL/Fl_Preferences.H
+++ b/FL/Fl_Preferences.H
@@ -50,21 +50,16 @@
    preferences file should be kept small for performance
    reasons. One application can have multiple preferences files.
    Extensive binary data however should be stored in separate
-   files: see getUserdataPath().
+   files: see \a Fl_Preferences::getUserdataPath() .
  
- \note Platform-specific location of the Fl_Preferences text files.
- This construct
-  \code new Fl_Preferences(Fl_Preferences::USER, "vendor", "application"); \endcode
- where "vendor" and "application" are any user-chosen strings, will create these text files:
- \li Windows XP platform: <tt>C:\\Documents and Settings\\<i>username</i>\\Application Data\\<i>vendor</i>\\<i>application</i>.prefs</tt>
- \li Windows 7+ platform: <tt>C:\\Users\\<i>username</i>\\AppData\\Roaming\\<i>vendor</i>\\<i>application</i>.prefs </tt>
- \li X11 platform: <tt>$HOME/.fltk/<i>vendor</i>/<i>application</i>.prefs </tt>
- \li MacOS platform: <tt>$HOME/Library/Preferences/<i>vendor</i>/<i>application</i>.prefs </tt>
-
    \note Starting with FLTK 1.3, preference databases are expected to
    be in UTF-8 encoding. Previous databases were stored in the
    current character set or code page which renders them incompatible
    for text entries using international characters.
+
+   \note Starting with FLTK 1.4, searching a valid path to store the preferences
+   files has changed slightly. Please see <i>Fl_Preferences::Fl_Preferences(Root, const char*, const char*)</i>
+   for details.
  */
 class FL_EXPORT Fl_Preferences {
 
-- 
cgit v1.2.3