diff options
| author | Fabien Costantini <fabien@onepost.net> | 2009-03-24 01:40:44 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2009-03-24 01:40:44 +0000 |
| commit | 15489bda1b2c9a4db82965a85634674d5d7f2dbe (patch) | |
| tree | 0bd04bb1d127ad7aca0d09141993c32a20c2eb10 /src/Fl_Preferences.cxx | |
| parent | 2fb4b11e9140cbf7bc19c566c71cdb935296b4e3 (diff) | |
Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6716 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_Preferences.cxx')
| -rw-r--r-- | src/Fl_Preferences.cxx | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/src/Fl_Preferences.cxx b/src/Fl_Preferences.cxx index 314841ed0..2128666d6 100644 --- a/src/Fl_Preferences.cxx +++ b/src/Fl_Preferences.cxx @@ -91,8 +91,8 @@ Fl_Preferences::Fl_Preferences( Root root, const char *vendor, const char *appli arbitrary position in the file system. The file name is generated in the form - <tt><i>path</i>/<i>application</i>.prefs</tt>. If \a application - is \c NULL, \a path must contain the full file name. + <tt><i>path</i>/<i>application</i>.prefs</tt>. If \p application + is \c NULL, \p path must contain the full file name. \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 @@ -108,8 +108,8 @@ Fl_Preferences::Fl_Preferences( const char *path, const char *vendor, const char /** \brief Generate or read a new group of entries within another group. - Use the \a group argument to name the group that you would like to access. - \a Group can also contain a path to a group further down the hierarchy by + Use the \p group argument to name the group that you would like to access. + \p Group can also contain a path to a group further down the hierarchy by separating group names with a forward slash '/'. \param[in] parent reference object for the new group @@ -164,7 +164,7 @@ int Fl_Preferences::groups() /** - Returns the name of the Nth (\a num_group) group. + Returns the name of the Nth (\p num_group) group. There is no guaranteed order of group names. The index must be within the range given by groups(). @@ -249,7 +249,7 @@ char Fl_Preferences::entryExists( const char *key ) /** Deletes a single name/value pair. - This function removes the entry \a key from the database. + This function removes the entry \p key from the database. \param[in] key name of entry to delete \return 0 if deleting the entry failed @@ -285,7 +285,7 @@ char Fl_Preferences::get( const char *key, int &value, int defaultValue ) file. \param[in] key name of entry - \param[in] value set this entry to \a value + \param[in] value set this entry to \p value \return 0 if setting the value failed */ char Fl_Preferences::set( const char *key, int value ) @@ -321,7 +321,7 @@ char Fl_Preferences::get( const char *key, float &value, float defaultValue ) file. \param[in] key name of entry - \param[in] value set this entry to \a value + \param[in] value set this entry to \p value \return 0 if setting the value failed */ char Fl_Preferences::set( const char *key, float value ) @@ -339,7 +339,7 @@ char Fl_Preferences::set( const char *key, float value ) file. \param[in] key name of entry - \param[in] value set this entry to \a value + \param[in] value set this entry to \p value \param[in] precision number of decimal digits to represent value \return 0 if setting the value failed */ @@ -376,7 +376,7 @@ char Fl_Preferences::get( const char *key, double &value, double defaultValue ) file. \param[in] key name of entry - \param[in] value set this entry to \a value + \param[in] value set this entry to \p value \return 0 if setting the value failed */ char Fl_Preferences::set( const char *key, double value ) @@ -394,7 +394,7 @@ char Fl_Preferences::set( const char *key, double value ) file. \param[in] key name of entry - \param[in] value set this entry to \a value + \param[in] value set this entry to \p value \param[in] precision number of decimal digits to represent value \return 0 if setting the value failed */ @@ -502,7 +502,7 @@ char Fl_Preferences::get( const char *key, char *&text, const char *defaultValue file. \param[in] key name of entry - \param[in] text set this entry to \a value + \param[in] text set this entry to \p value \return 0 if setting the value failed */ char Fl_Preferences::set( const char *key, const char *text ) @@ -628,7 +628,7 @@ char Fl_Preferences::get( const char *key, void *&data, const void *defaultValue file. \param[in] key name of entry - \param[in] data set this entry to \a value + \param[in] data set this entry to \p value \param[in] dsize size of data array \return 0 if setting the value failed */ |
