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

corrected some typos and wrong argument references.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6189 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2008-09-02 20:25:52 +00:00
parent c7f4b8c930
commit c3b29633d7
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
FL/Fl_Preferences.H
View File

@ -42,7 +42,7 @@
/** /**
* <tt>Fl_Preferences </tt>provides methods to store user * <tt>Fl_Preferences </tt>provides methods to store user
* setting between application starts. It is similar to the * settings between application starts. It is similar to the
* Registry on WIN32 and Preferences on MacOS, and provides a * Registry on WIN32 and Preferences on MacOS, and provides a
* simple configuration mechanism for UNIX. * simple configuration mechanism for UNIX.
* *
@ -62,8 +62,8 @@
* Entries can be of any length. However, the size of each * Entries can be of any length. However, the size of each
* preferences file should be kept under 100k for performance * preferences file should be kept under 100k for performance
* reasons. One application can have multiple preferences files. * reasons. One application can have multiple preferences files.
* Extensive binary data however should be stored in seperate * Extensive binary data however should be stored in separate
* files; see getUserdataPath() * files; see getUserdataPath().
*/ */
class FL_EXPORT Fl_Preferences class FL_EXPORT Fl_Preferences
{ {
@ -74,7 +74,7 @@ public:
* Define the scope of the preferences. * Define the scope of the preferences.
*/ */
enum Root { enum Root {
SYSTEM=0, ///< Preferences are uses system-wide SYSTEM=0, ///< Preferences are used system-wide
USER ///< Preferences apply only to the current user USER ///< Preferences apply only to the current user
}; };
// enum Type { win32, macos, fltk }; // enum Type { win32, macos, fltk };
@ -98,7 +98,7 @@ public:
* *
* \param[in] root can be USER or SYSTEM for user specific or system wide preferences * \param[in] root can be USER or SYSTEM for user specific or system wide preferences
* \param[in] vendor unique text describing the company or author of this file * \param[in] vendor unique text describing the company or author of this file
* \param[in] application unique text describing application * \param[in] application unique text describing the application
*/ */
Fl_Preferences( Root root, const char *vendor, const char *application ); Fl_Preferences( Root root, const char *vendor, const char *application );
@ -110,13 +110,13 @@ public:
* *
* \param[in] path path to the directory that contains the preferences file * \param[in] path path to the directory that contains the preferences file
* \param[in] vendor unique text describing the company or author of this file * \param[in] vendor unique text describing the company or author of this file
* \param[in] application unique text describing application * \param[in] application unique text describing the application
*/ */
Fl_Preferences( const char *path, const char *vendor, const char *application ); Fl_Preferences( const char *path, const char *vendor, const char *application );
/** /**
* This constructor generates a new group of preference entries * This constructor generates a new group of preference entries
* inside the group or file <i>p</i>. The <tt>groupname</tt> argument * inside the group or file <i>parent</i>. The <tt>group</tt> argument
* identifies a group of entries. It can contain '/'s to get quick * identifies a group of entries. It can contain '/'s to get quick
* access to individual elements inside the hierarchy. * access to individual elements inside the hierarchy.
* *
@ -178,7 +178,7 @@ public:
/** /**
* Return the number of entries (name/value) pairs in a group. * Returns the number of entries (name/value pairs) in a group.
* *
* \return number of entries * \return number of entries
*/ */