mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed Fl_Preferences documentation typos.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9228 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2012-01-18 11:39:57 +00:00
parent c7b0467518
commit 92d846caa4
2 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
FL/Fl_Preferences.H
View File

@ -27,16 +27,16 @@
/**
\brief Fl_Preferences provides methods to store user
settings between application starts.
settings between application starts.
It is similar to the
Registry on WIN32 and Preferences on MacOS, and provides a
simple configuration mechanism for UNIX.
Fl_Preferences uses a hierarchy to store data. It
bundles similar data into groups and manages entries into those
groups as name/value pairs.
Preferences are stored in text files that can be edited
manually. The file format is easy to read and relatively
forgiving. Preferences files are the same on all platforms. User
@ -45,16 +45,16 @@
scheme. The user must provide default values for all entries to
ensure proper operation should preferences be corrupted or not
yet exist.
Entries can be of any length. However, the size of each
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().
\note Starting with FLTK 1.3, preference databases are expected to
be in utf8 encoding. Previous databases were stored in the
current chracter set or code page which renders them incompatible
\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.
*/
class FL_EXPORT Fl_Preferences {
@ -101,7 +101,7 @@ public:
*/
const char *name() { return node->name(); }
/** Return the the full path to this entry.
/** Return the full path to this entry.
*/
const char *path() { return node->path(); }
@ -145,12 +145,13 @@ public:
// char import( const char *filename );
/**
'Name' provides a simple method to create numerical or more complex
'Name' provides a simple method to create numerical or more complex
procedural names for entries and groups on the fly.
Example: prefs.set(Fl_Preferences::Name("File%d",i),file[i]);.
Example: prefs.set(Fl_Preferences::Name("File%d",i),file[i]);.
See test/preferences.cxx as a sample for writing arrays into preferences.<p>
See test/preferences.cxx as a sample for writing arrays into preferences.
'Name' is actually implemented as a class inside Fl_Preferences. It casts
into const char* and gets automatically destroyed after the enclosing call
ends.

6
src/Fl_Preferences.cxx
View File

@ -330,7 +330,7 @@ Fl_Preferences::Fl_Preferences( Fl_Preferences *parent, int groupIndex ) {
An ID can be retrieved from any Fl_Preferences dataset, and can then be used
to create multiple new references to the same dataset.
ID's can be put very helpful when put into the <tt>user_data()</tt> field of
ID's can be very helpful when put into the <tt>user_data()</tt> field of
widget callbacks.
*/
Fl_Preferences::Fl_Preferences( Fl_Preferences::ID id ) {
@ -370,7 +370,7 @@ Fl_Preferences::~Fl_Preferences() {
if (node && !node->parent()) delete rootNode;
// DO NOT delete nodes! The root node will do that after writing the preferences
// zero all pointer to avoid memory errors, even though
// Valgrind does not complain (Cygwind does though)
// Valgrind does not complain (Cygwin does though)
node = 0L;
rootNode = 0L;
}
@ -657,7 +657,7 @@ static char *decodeText( const char *src ) {
supplied. The return value indicates if the value was available
(non-zero) or the default was used (0).
'maxSize' is the maximum length of text that will be read.
The text buffer must allow for one additional byte for a trailling zero.
The text buffer must allow for one additional byte for a trailing zero.
\param[in] key name of entry
\param[out] text returned from preferences or default value if none was set