Author: AlbrechtS
Date: 2008-12-13 11:40:26 -0800 (Sat, 13 Dec 2008)
New Revision: 6583
Log:
more doxygen updates
Modified:
branches/branch-1.3/FL/Fl_Widget.H
branches/branch-1.3/src/Fl_Browser.cxx
branches/branch-1.3/src/Fl_Gl_Overlay.cxx
branches/branch-1.3/src/Fl_Gl_Window.cxx
branches/branch-1.3/src/Fl_Menu_add.cxx
branches/branch-1.3/src/Fl_Preferences.cxx
Modified: branches/branch-1.3/FL/Fl_Widget.H
===================================================================
--- branches/branch-1.3/FL/Fl_Widget.H 2008-12-13 18:31:54 UTC (rev 6582)
+++ branches/branch-1.3/FL/Fl_Widget.H 2008-12-13 19:40:26 UTC (rev 6583)
@@ -588,7 +588,7 @@
\li 0: The callback is not done, but changed() is turned on.
\li FL_WHEN_CHANGED: The callback is done each time the text is
- changed by the user.</LI>
+ changed by the user.
\li FL_WHEN_RELEASE: The callback will be done when this widget loses
the focus, including when the window is unmapped. This is a useful
value for text fields in a panel where doing the callback on every
Modified: branches/branch-1.3/src/Fl_Browser.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Browser.cxx 2008-12-13 18:31:54 UTC (rev
6582)
+++ branches/branch-1.3/src/Fl_Browser.cxx 2008-12-13 19:40:26 UTC (rev
6583)
@@ -448,7 +448,7 @@
}
/**
- Updates the browser so that \a line is shown at position \pos.
+ Updates the browser so that \a line is shown at position \a pos.
\param[in] line line number.
\param[in] pos position.
*/
Modified: branches/branch-1.3/src/Fl_Gl_Overlay.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Gl_Overlay.cxx 2008-12-13 18:31:54 UTC (rev
6582)
+++ branches/branch-1.3/src/Fl_Gl_Overlay.cxx 2008-12-13 19:40:26 UTC (rev
6583)
@@ -230,7 +230,7 @@
glDrawBuffer(GL_FRONT);
#endif
}
-/** Hides the window if it is not this window, does nothing in WIN32*/
+/** Hides the window if it is not this window, does nothing in WIN32. */
void Fl_Gl_Window::hide_overlay() {
#if HAVE_GL_OVERLAY
#ifdef WIN32
Modified: branches/branch-1.3/src/Fl_Gl_Window.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Gl_Window.cxx 2008-12-13 18:31:54 UTC (rev
6582)
+++ branches/branch-1.3/src/Fl_Gl_Window.cxx 2008-12-13 19:40:26 UTC (rev
6583)
@@ -201,7 +201,7 @@
}
/**
- Set the projection so 0,0 is in the lower left of the window and each
+ Sets the projection so 0,0 is in the lower left of the window and each
pixel is 1 unit wide/tall. If you are drawing 2D images, your
draw() method may want to call this if valid() is false.
*/
@@ -408,12 +408,12 @@
Returns or sets a pointer to the GLContext that this window is
using. This is a system-dependent structure, but it is portable to copy
the context from one window to another. You can also set it to NULL,
- which will force FLTK to recreate the context the next time make_current()
is called, this is
- useful for getting around bugs in OpenGL implementations.
+ which will force FLTK to recreate the context the next time make_current()
+ is called, this is useful for getting around bugs in OpenGL implementations.
- <p>If <i>destroy_flag</i> is true the context will be destroyed by
- fltk when the window is destroyed, or when the mode() is changed, or the
next time
- context(x) is called.
+ If <i>destroy_flag</i> is true the context will be destroyed by
+ fltk when the window is destroyed, or when the mode() is changed,
+ or the next time context(x) is called.
*/
void Fl_Gl_Window::context(void* v, int destroy_flag) {
if (context_ && !(mode_&NON_LOCAL_CONTEXT)) fl_delete_gl_context(context_);
@@ -472,7 +472,8 @@
using system-specific calls), and remember that you are in an indexed
OpenGL mode and drawing anything other than flat-shaded will probably
not work.
- <P>Both this function and Fl_Gl_Window::draw() should check
+
+ Both this function and Fl_Gl_Window::draw() should check
Fl_Gl_Window::valid() and set the same transformation. If you
don't your code may not work on other systems. Depending on the OS,
and on whether overlays are real or simulated, the OpenGL context may
@@ -483,16 +484,18 @@
#endif
/**
- You <b>must</b> subclass Fl_Gl_Window and provide an implementation for
+ You \e \b must subclass Fl_Gl_Window and provide an implementation for
draw(). You may also provide an implementation of draw_overlay()
if you want to draw into the overlay planes. You can avoid
reinitializing the viewport and lights and other things by checking
valid() at the start of draw() and only doing the
initialization if it is false.
- <P>The draw() method can <I>only</I> use OpenGL calls. Do not
- attempt to call X, any of the functions in <FL/fl_draw.H>, or glX
- directly. Do not call gl_start() or gl_finish(). </P>
- <P>If double-buffering is enabled in the window, the back and front
+
+ The draw() method can <I>only</I> use OpenGL calls. Do not
+ attempt to call X, any of the functions in <FL/fl_draw.H>, or glX
+ directly. Do not call gl_start() or gl_finish().
+
+ If double-buffering is enabled in the window, the back and front
buffers are swapped after this function is completed.
*/
void Fl_Gl_Window::draw() {
Modified: branches/branch-1.3/src/Fl_Menu_add.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Menu_add.cxx 2008-12-13 18:31:54 UTC (rev
6582)
+++ branches/branch-1.3/src/Fl_Menu_add.cxx 2008-12-13 19:40:26 UTC (rev
6583)
@@ -179,41 +179,40 @@
/**
Adds a new menu item, with a title string, shortcut int (or string),
callback, argument to the callback, and flags.
- If the menu array was directly set with menu(x) then copy() is done
+ If the menu array was directly set with menu(x), then copy() is done
to make a private array.
- <p>The characters "&", "/", "\", and "_" are treated as
+ The characters "&", "/", "\", and "_" are treated as
special characters in the label string. The "&" character
specifies that the following character is an accelerator and
will be underlined. The "\" character is used to escape the next
character in the string. Labels starting with the "_" character
- cause a divider to be placed after that menu item.</p>
+ cause a divider to be placed after that menu item.
- <p>A label of the form "foo/bar/baz" will create a
- submenus called "foo" and "bar" with an
- entry called "baz". The "/" character is ignored if it
- appears as the first character of the label string, e.g.
- "/foo/bar/baz".</p>
+ A label of the form "foo/bar/baz" will create submenus called
+ "foo" and "bar" with an entry called "baz". The "/" character is
+ ignored if it appears as the first character of the label string, e.g.
+ "/foo/bar/baz".
- <p>The label string is copied to new memory and can be freed.
+ The label string is copied to new memory and can be freed.
The other arguments (including the shortcut) are copied into the
- menu item unchanged. </P>
+ menu item unchanged.
- <P>If an item exists already with that name then it is replaced with
+ If an item exists already with that name then it is replaced with
this new one. Otherwise this new one is added to the end of the
correct menu or submenu. The return value is the offset into the array
- that the new entry was placed at.</P>
+ that the new entry was placed at.
- <P>Shortcut can be 0L, or either a modifier/key combination (for example
- FL_CTRL+'A') or a string describing the shortcut in one of two ways:</p>
+ Shortcut can be 0L, or either a modifier/key combination (for example
+ FL_CTRL+'A') or a string describing the shortcut in one of two ways:
\code
- [#+^]<ascii_value>� eg. "97", "^97", "+97", "#97"
- [#+^]<ascii_char>� eg. "a", "^a", "+a", "#a"
+ [#+^]<ascii_value> e.g. "97", "^97", "+97", "#97"
+ [#+^]<ascii_char> e.g. "a", "^a", "+a", "#a"
\endcode
- ..where <ascii_value> is a decimal value representing an
+ ..where \<ascii_value\> is a decimal value representing an
ascii character (eg. 97 is the ascii for 'a'), and the optional
- prefixes enhance the value that follows. Multiple prefixes must
+ prefixes enhance the value that follows. Multiple prefixes must
appear in the above order.
\code
# - Alt
@@ -223,11 +222,9 @@
Text shortcuts are converted to integer shortcut by calling
int fl_old_shortcut(const char*).
- <P>The return value is the index into the array that the entry was put. </P>
+ The return value is the index into the array that the entry was put.
- <P>No items must be added to a menu during a callback to the same menu.</P>
-
-
+ No items must be added to a menu during a callback to the same menu.
*/
int Fl_Menu_::add(const char *t, int s, Fl_Callback *c,void *v,int f) {
// make this widget own the local array:
@@ -280,9 +277,9 @@
add(s,0,0,0,0) is done with each section. This is
often useful if you are just using the value, and is compatible
with Forms and other GL programs. The section strings use the
- same special characters as described for the long version of add()</p>
-
- <P>No items must be added to a menu during a callback to the same menu.
+ same special characters as described for the long version of add().
+
+ No items must be added to a menu during a callback to the same menu.
*/
int Fl_Menu_::add(const char *str) {
char buf[1024];
@@ -302,7 +299,7 @@
}
/**
- Changes the text of item n. This is the only way to get
+ Changes the text of item \a i. This is the only way to get
slash into an add()'ed menu item. If the menu array was directly set
with menu(x) then copy() is done to make a private array.
*/
@@ -316,10 +313,10 @@
menu_[i].text = str;
}
/**
- Deletes item n from the menu. If the menu array was directly
+ Deletes item \a i from the menu. If the menu array was directly
set with menu(x) then copy() is done to make a private array.
- <P>No items must be removed from a menu during a callback to the same menu.
+ No items must be removed from a menu during a callback to the same menu.
*/
void Fl_Menu_::remove(int i) {
int n = size();
Modified: branches/branch-1.3/src/Fl_Preferences.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Preferences.cxx 2008-12-13 18:31:54 UTC (rev
6582)
+++ branches/branch-1.3/src/Fl_Preferences.cxx 2008-12-13 19:40:26 UTC (rev
6583)
@@ -103,7 +103,7 @@
/**
- \brief Gnerate or read a new group of entries within another group.
+ \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
@@ -150,8 +150,7 @@
/**
- Returns the number of groups that are contained within a
- group.
+ Returns the number of groups that are contained within a group.
\return 0 for no groups at all
*/
@@ -162,9 +161,9 @@
/**
- Returns the name of the Nth group. There is no guaranteed
- order of group names. The index must be within the range given
- by groups().
+ Returns the name of the Nth (\a num_group) group.
+ There is no guaranteed order of group names. The index must
+ be within the range given by groups().
\param[in] num_group number indexing the requested group
\return 'C' string pointer to the group name
@@ -193,7 +192,7 @@
/**
Deletes a group.
- Remove a group and all keys and groups within that group
+ Removes a group and all keys and groups within that group
from the database.
\param[in] group name of the group to delete
@@ -245,10 +244,9 @@
/**
- Delete a single name/value pair.
+ Deletes a single name/value pair.
- This function removes the entry from the
- database.
+ This function removes the entry \a key from the database.
\param[in] key name of entry to delete
\return 0 if deleting the entry failed
@@ -697,8 +695,8 @@
}
/**
- Write all preferences to disk. This function works only with
- the base preference group. This function is rarely used as
+ Writes all preferences to disk. This function works only with
+ the base preferences group. This function is rarely used as
deleting the base preferences flushes automatically.
*/
void Fl_Preferences::flush()
@@ -712,17 +710,17 @@
//
/**
- * Create a group name or entry name on the fly.
- *
- * This version creates a simple unsigned integer as an entry name.
- *
- * \code
- * int n, i;
- * Fl_Preferences prev( appPrefs, "PreviousFiles" );
- * prev.get( "n", 0 );
- * for ( i=0; i<n; i++ )
- * prev.get( Fl_Preferences::Name(i), prevFile[i], "" );
- * \endcode
+ Creates a group name or entry name on the fly.
+
+ This version creates a simple unsigned integer as an entry name.
+
+ \code
+ int n, i;
+ Fl_Preferences prev( appPrefs, "PreviousFiles" );
+ prev.get( "n", 0 );
+ for ( i=0; i<n; i++ )
+ prev.get( Fl_Preferences::Name(i), prevFile[i], "" );
+ \endcode
*/
Fl_Preferences::Name::Name( unsigned int n )
{
@@ -731,17 +729,17 @@
}
/**
- * Create a group name or entry name on the fly.
- *
- * This version creates entry names as in 'printf'.
- *
- * \code
- * int n, i;
- * Fl_Preferences prefs( USER, "matthiasm.com", "test" );
- * prev.get( "nFiles", 0 );
- * for ( i=0; i<n; i++ )
- * prev.get( Fl_Preferences::Name( "File%d", i ), prevFile[i], "" );
- * \endcode
+ Creates a group name or entry name on the fly.
+
+ This version creates entry names as in 'printf'.
+
+ \code
+ int n, i;
+ Fl_Preferences prefs( USER, "matthiasm.com", "test" );
+ prev.get( "nFiles", 0 );
+ for ( i=0; i<n; i++ )
+ prev.get( Fl_Preferences::Name( "File%d", i ), prevFile[i], "" );
+ \endcode
*/
Fl_Preferences::Name::Name( const char *format, ... )
{
_______________________________________________
fltk-commit mailing list
fltk-commit@easysw.com
http://lists.easysw.com/mailman/listinfo/fltk-commit
