Fixed typos and doxygen documentation.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6582 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 89 insertions, 56 deletions

diff --git a/FL/Fl_Menu_Item.H b/FL/Fl_Menu_Item.H
index 353c6e22e..dc67dd6d2 100644
--- a/FL/Fl_Menu_Item.H
+++ b/FL/Fl_Menu_Item.H
@@ -101,57 +101,64 @@ class Fl_Menu_;
    {0}};
   \endcode
   produces:
-  <P ALIGN=CENTER>\image html  menu.gif </P>
+
+  \image html   menu.gif
   \image latex  menu.eps "menu" width=10cm
+
   A submenu title is identified by the bit FL_SUBMENU in the 
   flags field, and ends with a label() that is NULL.
   You can nest menus to any depth.  A pointer to the first item in the
   submenu can be treated as an Fl_Menu array itself.  It is also
-  possible to make seperate submenu arrays with FL_SUBMENU_POINTER
-  flags.
-  <P>You should use the method functions to access structure members and
+  possible to make separate submenu arrays with FL_SUBMENU_POINTER flags.
+
+  You should use the method functions to access structure members and
   not access them directly to avoid compatibility problems with future
   releases of FLTK.
 */
 struct FL_EXPORT Fl_Menu_Item {
   const char *text;	    ///< menu item text, returned by label()
-  int shortcut_;	    ///<  menu item shortcut
-  Fl_Callback *callback_;   ///<  menu item callback
-  void *user_data_;	    ///<  menu item user_data for 3rd party apps
-  int flags;		    ///<  menu item flags like FL_MENU_TOGGLE,FL_MENU_RADIO
-  uchar labeltype_;	    ///<  how the menu item text looks like
-  Fl_Font labelfont_;	    ///<  which font for this menu item text
-  Fl_Fontsize labelsize_;   ///<  size of menu item text
-  unsigned labelcolor_;	    ///<  menu item text color 
+  int shortcut_;	    ///< menu item shortcut
+  Fl_Callback *callback_;   ///< menu item callback
+  void *user_data_;	    ///< menu item user_data for 3rd party apps
+  int flags;		    ///< menu item flags like FL_MENU_TOGGLE, FL_MENU_RADIO
+  uchar labeltype_;	    ///< how the menu item text looks like
+  Fl_Font labelfont_;	    ///< which font for this menu item text
+  Fl_Fontsize labelsize_;   ///< size of menu item text
+  unsigned labelcolor_;	    ///< menu item text color 
 
   // advance N items, skipping submenus:
   const Fl_Menu_Item *next(int=1) const;
+
   /**
-    Advance a pointer by n items through a menu array, skipping
-    the contents of submenus and invisible items.  There are two calls so
+    Advances a pointer by n items through a menu array, skipping
+    the contents of submenus and invisible items. There are two calls so
     that you can advance through const and non-const data.
   */
   Fl_Menu_Item *next(int i=1) {
     return (Fl_Menu_Item*)(((const Fl_Menu_Item*)this)->next(i));}
+
   /** Returns the first menu item, same as next(0). */
   const Fl_Menu_Item *first() const { return next(0); }
+
   /** Returns the first menu item, same as next(0). */
   Fl_Menu_Item *first() { return next(0); }
 
   // methods on menu items:
   /**
-    This is the title of the item.  A NULL here indicates the end
-    of the menu (or of a submenu).  A '&' in the item will print an
-    underscore under the next letter, and if the menu is popped up that
-    letter will be a "shortcut" to pick that item.  To get a
-    real '&' put two
-    in a row.
+    Returns the title of the item.
+    A NULL here indicates the end of the menu (or of a submenu).
+    A '&' in the item will print an underscore under the next letter,
+    and if the menu is popped up that letter will be a "shortcut" to pick 
+    that item.  To get a real '&' put two in a row.
   */
   const char* label() const {return text;}
+
   /**    See const char* Fl_Menu_Item::label() const   */
   void label(const char* a) {text=a;}
+
   /**    See const char* Fl_Menu_Item::label() const   */
   void label(Fl_Labeltype a,const char* b) {labeltype_ = a; text = b;}
+
   /**
     A labeltype identifies a routine that draws the label of the
     widget.  This can be used for special effects such as emboss, or to use
@@ -159,6 +166,7 @@ struct FL_EXPORT Fl_Menu_Item {
     The value FL_NORMAL_LABEL prints the label as text.
   */
   Fl_Labeltype labeltype() const {return (Fl_Labeltype)labeltype_;}
+
   /**
     A labeltype identifies a routine that draws the label of the
     widget.  This can be used for special effects such as emboss, or to use
@@ -166,6 +174,7 @@ struct FL_EXPORT Fl_Menu_Item {
     The value FL_NORMAL_LABEL prints the label as text.
   */
   void labeltype(Fl_Labeltype a) {labeltype_ = a;}
+
   /**
     This color is passed to the labeltype routine, and is typically the
     color of the label text.  This defaults to FL_BLACK.  If this
@@ -173,43 +182,49 @@ struct FL_EXPORT Fl_Menu_Item {
     the menu - this is so that images put in the menu draw correctly.
   */
   Fl_Color labelcolor() const {return (Fl_Color)labelcolor_;}
+
   /** See Fl_Color Fl_Menu_Item::labelcolor() const */
   void labelcolor(unsigned a) {labelcolor_ = a;}
   /**
-    Fonts are identified by small 8-bit indexes into a table.  See the 
+    Fonts are identified by small 8-bit indexes into a table. See the 
     enumeration list for predefined fonts. The default value is a
-    Helvetica font.  The function 
-    Fl::set_font() can define new fonts.
+    Helvetica font. The function Fl::set_font() can define new fonts.
   */
   Fl_Font labelfont() const {return labelfont_;}
+
   /**
-    Fonts are identified by small 8-bit indexes into a table.  See the 
+    Fonts are identified by small 8-bit indexes into a table. See the 
     enumeration list for predefined fonts. The default value is a
-    Helvetica font.  The function 
-    Fl::set_font() can define new fonts.
+    Helvetica font.  The function Fl::set_font() can define new fonts.
   */
   void labelfont(Fl_Font a) {labelfont_ = a;}
-  /**    Gets or sets the label font pixel size/height.  */
+
   /** Gets the label font pixel size/height.*/
   Fl_Fontsize labelsize() const {return labelsize_;}
+
   /** Sets the label font pixel size/height.*/
   void labelsize(Fl_Fontsize a) {labelsize_ = a;}
 
   /**
      Each item has space for a callback function and an argument for that
-     function.  Due to back compatibility, the Fl_Menu_Item itself
+     function. Due to back compatibility, the Fl_Menu_Item itself
      is not passed to the callback, instead you have to get it by calling 
-     ((Fl_Menu_*)w)-&gt;mvalue() where w is the widget argument.
+     ((Fl_Menu_*)w)->mvalue() where w is the widget argument.
   */
   Fl_Callback_p callback() const {return callback_;}
+
   /** See Fl_Callback_p Fl_MenuItem::callback() const */
   void callback(Fl_Callback* c, void* p) {callback_=c; user_data_=p;}
+
   /** See Fl_Callback_p Fl_MenuItem::callback() const */
   void callback(Fl_Callback* c) {callback_=c;}
+
   /** See Fl_Callback_p Fl_MenuItem::callback() const */
   void callback(Fl_Callback0*c) {callback_=(Fl_Callback*)c;}
+
   /** See Fl_Callback_p Fl_MenuItem::callback() const */
   void callback(Fl_Callback1*c, long p=0) {callback_=(Fl_Callback*)c; user_data_=(void*)p;}
+
   /**
     Get or set the user_data argument that is sent to the
     callback function.
@@ -234,21 +249,24 @@ struct FL_EXPORT Fl_Menu_Item {
     portable to some machines.
   */
   void argument(long v) {user_data_ = (void*)v;}
+
   /** Gets what key combination shortcut will trigger the menu item. */
   int shortcut() const {return shortcut_;}
+
   /**
     Sets exactly what key combination will trigger the menu item.  The
     value is a logical 'or' of a key and a set of shift flags, for instance 
     FL_ALT+'a' or FL_ALT+FL_F+10 or just 'a'.  A value of
     zero disables the shortcut.
-    <P>The key can be any value returned by 
-    Fl::event_key(), but will usually be an ASCII letter.  Use
-    a lower-case letter unless you require the shift key to be held down. </P>
-    <P>The shift flags can be any set of values accepted by 
-    Fl::event_state().  If the bit is on that shift key must
-    be pushed.  Meta, Alt, Ctrl, and Shift must be off if they are not in
-    the shift flags (zero for the other bits indicates a "don't care"
-    setting).
+
+    The key can be any value returned by Fl::event_key(), but will usually 
+    be an ASCII letter. Use a lower-case letter unless you require the shift 
+    key to be held down.
+
+    The shift flags can be any set of values accepted by Fl::event_state().
+    If the bit is on that shift key must be pushed.  Meta, Alt, Ctrl, 
+    and Shift must be off if they are not in the shift flags (zero for the 
+    other bits indicates a "don't care" setting).
   */
   void shortcut(int s) {shortcut_ = s;}
   /**
@@ -261,8 +279,7 @@ struct FL_EXPORT Fl_Menu_Item {
   int submenu() const {return flags&(FL_SUBMENU|FL_SUBMENU_POINTER);}
   /**
     Returns true if a checkbox will be drawn next to this item.  This is
-    true if FL_MENU_TOGGLE or FL_MENU_RADIO is set in the
-    flags.
+    true if FL_MENU_TOGGLE or FL_MENU_RADIO is set in the flags.
   */
   int checkbox() const {return flags&FL_MENU_TOGGLE;}
   /**
@@ -272,26 +289,32 @@ struct FL_EXPORT Fl_Menu_Item {
     item with FL_MENU_DIVIDER turned on.
   */
   int radio() const {return flags&FL_MENU_RADIO;}
-  /**    Returns the current value of the check or radio item.  */
+  /** Returns the current value of the check or radio item. */
   int value() const {return flags&FL_MENU_VALUE;}
   /**
     Turns the check or radio item "on" for the menu item. Note that this
-    does not turn off any adjacent radio items like set_only()
-    does.
+    does not turn off any adjacent radio items like set_only() does.
   */
   void set() {flags |= FL_MENU_VALUE;}
-  /**    Turns the check or radio item "off" for the menu item.  */
+
+  /** Turns the check or radio item "off" for the menu item. */
   void clear() {flags &= ~FL_MENU_VALUE;}
+
   void setonly();
-  /**    Gets the visibility of an item.  */
+
+  /** Gets the visibility of an item. */
   int visible() const {return !(flags&FL_MENU_INVISIBLE);}
-  /**    Makes an item visible in the menu.  */
+
+  /** Makes an item visible in the menu. */
   void show() {flags &= ~FL_MENU_INVISIBLE;}
-  /**    Hides an item in the menu.  */
+
+  /** Hides an item in the menu. */
   void hide() {flags |= FL_MENU_INVISIBLE;}
-  /**    Get whether or not the item can be picked.  */
+
+  /** Gets whether or not the item can be picked. */
   int active() const {return !(flags&FL_MENU_INACTIVE);}
-  /**    Allows a menu item to be picked.  */
+
+  /** Allows a menu item to be picked. */
   void activate() {flags &= ~FL_MENU_INACTIVE;}
   /**
     Prevents a menu item from being picked. Note that this will also cause
@@ -302,8 +325,10 @@ struct FL_EXPORT Fl_Menu_Item {
   int activevisible() const {return !(flags & (FL_MENU_INACTIVE|FL_MENU_INVISIBLE));}
 
   // compatibility for FLUID so it can set the image of a menu item...
+
   /** compatibility api for FLUID, same as a->label(this) */
   void image(Fl_Image* a) {a->label(this);}
+
   /** compatibility api for FLUID, same as a.label(this) */
   void image(Fl_Image& a) {a.label(this);}
 
@@ -327,39 +352,47 @@ struct FL_EXPORT Fl_Menu_Item {
   const Fl_Menu_Item* find_shortcut(int *ip=0) const;
 
   /**
-    Call the Fl_Menu_Item item's callback, and provide the 
-    Fl_Widget argument (and optionally override the user_data()
-    argument).  You must first check that callback() is non-zero
+    Calls the Fl_Menu_Item item's callback, and provides the 
+    Fl_Widget argument (and optionally overrides the user_data()
+    argument). You must first check that callback() is non-zero
     before calling this.
   */
   void do_callback(Fl_Widget* o) const {callback_(o, user_data_);}
+
   /**
-    Call the Fl_Menu_Item item's callback, and provide the 
-    Fl_Widget argument (and optionally override the user_data()
-    argument).  You must first check that callback() is non-zero
+    Calls the Fl_Menu_Item item's callback, and provides the 
+    Fl_Widget argument (and optionally overrides the user_data()
+    argument). You must first check that callback() is non-zero
     before calling this.
   */
   void do_callback(Fl_Widget* o,void* arg) const {callback_(o, arg);}
+
   /**
-    Call the Fl_Menu_Item item's callback, and provide the 
-    Fl_Widget argument (and optionally override the user_data()
+    Calls the Fl_Menu_Item item's callback, and provides the 
+    Fl_Widget argument (and optionally overrides the user_data()
     argument).  You must first check that callback() is non-zero
     before calling this.
   */
   void do_callback(Fl_Widget* o,long arg) const {callback_(o, (void*)arg);}
 
   // back-compatibility, do not use:
+
   /** back compatibility only \deprecated. */
   int checked() const {return flags&FL_MENU_VALUE;}
+
   /** back compatibility only \deprecated. */
   void check() {flags |= FL_MENU_VALUE;}
+
   /** back compatibility only \deprecated. */
   void uncheck() {flags &= ~FL_MENU_VALUE;}
+
   int add(const char*, int shortcut, Fl_Callback*, void* =0, int = 0);
+
   /** See int add(const char*, int shortcut, Fl_Callback*, void*, int) */
   int add(const char*a, const char* b, Fl_Callback* c,
 	  void* d = 0, int e = 0) {
     return add(a,fl_old_shortcut(b),c,d,e);}
+
   int size() const ;
 };