Documentation fixes and clarifications.

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

2 files changed, 53 insertions, 45 deletions

diff --git a/FL/Fl_Menu_.H b/FL/Fl_Menu_.H
index c609e7a8d..239258669 100644
--- a/FL/Fl_Menu_.H
+++ b/FL/Fl_Menu_.H
@@ -3,7 +3,7 @@
 //
 // Menu base class header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2016 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
 // the file "COPYING" which should have been included with this file.  If this
@@ -29,24 +29,24 @@
 
 /**
   Base class of all widgets that have a menu in FLTK.
-  Currently FLTK provides you with 
-  Fl_Menu_Button, Fl_Menu_Bar, and Fl_Choice.
-  
-  <P>The class contains a pointer to an array of structures of type  Fl_Menu_Item.  The
-  array may either be supplied directly by the user program, or it may
+
+  Currently FLTK provides you with Fl_Menu_Button, Fl_Menu_Bar, and Fl_Choice.
+
+  The class contains a pointer to an array of structures of type Fl_Menu_Item.
+  The array may either be supplied directly by the user program, or it may
   be "private": a dynamically allocated array managed by the Fl_Menu_.
 
   When the user clicks a menu item, value() is set to that item
   and then:
 
-      - If the Fl_Menu_Item has a callback set, that callback
-        is invoked with any userdata configured for it.
-        (The Fl_Menu_ widget's callback is NOT invoked.
+    - If the Fl_Menu_Item has a callback set, that callback
+      is invoked with any userdata configured for it.
+      (The Fl_Menu_ widget's callback is NOT invoked.)
 
-      - For any Fl_Menu_Items that \b don't have a callback set,
-        the Fl_Menu_ widget's callback is invoked with any userdata
-        configured for it. The callback can determine which item
-        was picked using value(), mvalue(), item_pathname(), etc.
+    - For any Fl_Menu_Items that \b don't have a callback set,
+      the Fl_Menu_ widget's callback is invoked with any userdata
+      configured for it. The callback can determine which item
+      was picked using value(), mvalue(), item_pathname(), etc.
 */
 class FL_EXPORT Fl_Menu_ : public Fl_Widget {
 
@@ -106,12 +106,12 @@ public:
     }
     \endcode
 
-  */  
+  */
   const Fl_Menu_Item *menu() const {return menu_;}
   void menu(const Fl_Menu_Item *m);
   void copy(const Fl_Menu_Item *m, void* user_data = 0);
   int insert(int index, const char*, int shortcut, Fl_Callback*, void* = 0, int = 0);
-  int  add(const char*, int shortcut, Fl_Callback*, void* = 0, int = 0);
+  int  add(const char*, int shortcut, Fl_Callback*, void* = 0, int = 0); // see src/Fl_Menu_add.cxx
   /** See int Fl_Menu_::add(const char* label, int shortcut, Fl_Callback*, void *user_data=0, int flags=0) */
   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);
@@ -127,7 +127,7 @@ public:
   int clear_submenu(int index);
   void replace(int,const char *);
   void remove(int);
- /** Changes the shortcut of item i to n.  */
+  /** Changes the shortcut of item \p i to \p s. */
   void shortcut(int i, int s) {menu_[i].shortcut(s);}
   /** Sets the flags of item i.  For a list of the flags, see Fl_Menu_Item.  */
   void mode(int i,int fl) {menu_[i].flags = fl;}
@@ -166,9 +166,9 @@ public:
 
   /**
     This box type is used to surround the currently-selected items in the
-    menus.  If this is FL_NO_BOX then it acts like 
-    FL_THIN_UP_BOX and selection_color() acts like 
-    FL_WHITE, for back compatibility.    
+    menus.  If this is FL_NO_BOX then it acts like
+    FL_THIN_UP_BOX and selection_color() acts like
+    FL_WHITE, for back compatibility.
   */
   Fl_Boxtype down_box() const {return (Fl_Boxtype)down_box_;}
   /**    See Fl_Boxtype Fl_Menu_::down_box() const   */
diff --git a/FL/Fl_Menu_Bar.H b/FL/Fl_Menu_Bar.H
index 98127e33c..dcb76652a 100644
--- a/FL/Fl_Menu_Bar.H
+++ b/FL/Fl_Menu_Bar.H
@@ -3,7 +3,7 @@
 //
 // Menu bar header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2016 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
 // the file "COPYING" which should have been included with this file.  If this
@@ -29,35 +29,39 @@
   put this widget along the top edge of your window.  The height of the
   widget should be 30 for the menu titles to draw correctly with the
   default font.
-  <P>The items on the bar and the menus they bring up are defined by a
-  single Fl_Menu_Item
-  array.  Because a Fl_Menu_Item array defines a hierarchy, the
+
+  The items on the bar and the menus they bring up are defined by a
+  single Fl_Menu_Item array.
+  Because a Fl_Menu_Item array defines a hierarchy, the
   top level menu defines the items in the menubar, while the submenus
   define the pull-down menus. Sub-sub menus and lower pop up to the right
-  of the submenus. </P>
-  <P ALIGN=CENTER>\image html  menubar.png</P>
+  of the submenus.
+
+  \image html  menubar.png
   \image latex  menubar.png " menubar" width=12cm
-  <P>If there is an item in the top menu that is not a title of a
+
+  If there is an item in the top menu that is not a title of a
   submenu, then it acts like a "button" in the menubar.  Clicking on it
-  will pick it. </P>
+  will pick it.
 
   When the user clicks a menu item, value() is set to that item
   and then:
 
-      - The item's callback is done if one has been set; the
-        Fl_Menu_Bar is passed as the Fl_Widget* argument, 
-        along with any userdata configured for the callback.
+    - The item's callback is done if one has been set; the
+      Fl_Menu_Bar is passed as the Fl_Widget* argument,
+      along with any userdata configured for the callback.
 
-      - If the item does not have a callback, the Fl_Menu_Bar's callback
-        is done instead, along with any userdata configured for the callback.
-        The callback can determine which item was picked using
-        value(), mvalue(), item_pathname(), etc.
+    - If the item does not have a callback, the Fl_Menu_Bar's callback
+      is done instead, along with any userdata configured for the callback.
+      The callback can determine which item was picked using
+      value(), mvalue(), item_pathname(), etc.
 
-  <P>Submenus will also pop up in response to shortcuts indicated by
+  Submenus will also pop up in response to shortcuts indicated by
   putting a '&' character in the name field of the menu item. If you put a
   '&' character in a top-level "button" then the shortcut picks it.  The
-  '&' character in submenus is ignored until the menu is popped up. </P>
-  <P>Typing the shortcut() of any of the menu items will cause
+  '&' character in submenus is ignored until the menu is popped up.
+
+  Typing the shortcut() of any of the menu items will cause
   callbacks exactly the same as when you pick the item with the mouse.
 */
 class FL_EXPORT Fl_Menu_Bar : public Fl_Menu_ {
@@ -66,20 +70,24 @@ protected:
 public:
     int handle(int);
   /**
-      Creates a new Fl_Menu_Bar widget using the given position,
+    Creates a new Fl_Menu_Bar widget using the given position,
     size, and label string. The default boxtype is FL_UP_BOX.
-    <P>The constructor sets menu() to NULL.  See 
-    Fl_Menu_ for the methods to set or change the menu. </P>
-    <P>labelsize(), labelfont(), and labelcolor()
+
+    The constructor sets menu() to NULL.  See
+    Fl_Menu_ for the methods to set or change the menu.
+
+    labelsize(), labelfont(), and labelcolor()
     are used to control how the menubar items are drawn.  They are
     initialized from the Fl_Menu static variables, but you can
-    change them if desired. </P>
-    <P>label() is ignored unless you change align() to
+    change them if desired.
+
+    label() is ignored unless you change align() to
     put it outside the menubar.
-    <P>The destructor removes the Fl_Menu_Bar widget and all of its
+
+    The destructor removes the Fl_Menu_Bar widget and all of its
     menu items.
   */
-  Fl_Menu_Bar(int X, int Y, int W, int H,const char *l=0);
+  Fl_Menu_Bar(int X, int Y, int W, int H, const char *l=0);
 };
 
 #endif