diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2020-05-24 14:18:08 +0200 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2020-05-24 14:18:08 +0200 |
| commit | ec15ac6c89c28895c5b14b95f57f1427faa77a97 (patch) | |
| tree | af7c21e64bd981c0b749d9017b6ab506063232da | |
| parent | b1a2c28ad6934c7729ce5395abaebcffb69a0e74 (diff) | |
Fix documentation typos and formatting
| -rw-r--r-- | FL/Fl_Preferences.H | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H index eff8e1aae..9690e456f 100644 --- a/FL/Fl_Preferences.H +++ b/FL/Fl_Preferences.H @@ -34,7 +34,7 @@ simple configuration mechanism for UNIX. Fl_Preferences uses a hierarchy to store data. It - bundles similar data into groups and manages entries into those + bundles similar data into groups and manages entries in these groups as name/value pairs. Preferences are stored in text files that can be edited @@ -53,13 +53,14 @@ files: see \a Fl_Preferences::getUserdataPath() . \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. + 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 + Fl_Preferences::Fl_Preferences(Root, const char*, const char*) + for details. */ class FL_EXPORT Fl_Preferences { @@ -68,9 +69,9 @@ public: Define the scope of the preferences. */ enum Root { - SYSTEM = 0, ///< Preferences are used system-wide - USER, ///< Preferences apply only to the current user - ROOT_MASK = 0xFF, //< maks for the values above + SYSTEM = 0, ///< Preferences are used system-wide + USER, ///< Preferences apply only to the current user + ROOT_MASK = 0xFF, ///< masks for the values above CORE = 0x100, ///< OR'd by FLTK to read and write core library preferences and options CORE_SYSTEM = CORE|SYSTEM, CORE_USER = CORE|USER |