From 46f08f6d21aa55f8c6539d2a0191622ef6464c5f Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Tue, 27 Nov 2018 12:41:39 +0000
Subject: Documentation: reveal where the Fl_Preferences text files are located
 on each platform.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13136 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Preferences.H | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H
index db0708967..af2c8fd87 100644
--- a/FL/Fl_Preferences.H
+++ b/FL/Fl_Preferences.H
@@ -51,6 +51,15 @@
    reasons. One application can have multiple preferences files.
    Extensive binary data however should be stored in separate
    files: see 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
-- 
cgit v1.2.3