Doxgen mods for Fl_Browser*:

	o Added \see for all methods that seemed to need it
	o Fix to has_scroll() enum docs as per Albrecht's comments
	o Other small doc tweaks



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

2 files changed, 45 insertions, 23 deletions

diff --git a/FL/Fl_Browser.H b/FL/Fl_Browser.H
index 4bd8cf617..8b144a039 100644
--- a/FL/Fl_Browser.H
+++ b/FL/Fl_Browser.H
@@ -115,11 +115,13 @@ protected:
   /** Swap the items \p a and \p b.
       You must call redraw() to make any changes visible.
       \param[in] a,b the items to be swapped.
+      \see swap(int,int), item_swap()
    */
   void item_swap(void *a, void *b) { swap((FL_BLINE*)a, (FL_BLINE*)b); }
   /** Return the item at specified \p line.
       \param[in] line The line of the item to return. (1 based)
       \returns The item, or NULL if line out of range.
+      \see item_at(), find_line(), lineno()
    */
   void *item_at(int line) const { return (void*)find_line(line); }
 
@@ -155,18 +157,21 @@ public:
     Scrolls the browser so the top item in the browser
     is showing the specified \p line.
     \param[in] line The line to be displayed at the top.
+    \see topline(), middleline(), bottomline(), displayed(), lineposition()
    */
   void topline(int line) { lineposition(line, TOP); }
   /**
     Scrolls the browser so the bottom item in the browser
     is showing the specified \p line.
     \param[in] line The line to be displayed at the bottom.
+    \see topline(), middleline(), bottomline(), displayed(), lineposition()
    */
   void bottomline(int line) { lineposition(line, BOTTOM); }
   /**
     Scrolls the browser so the middle item in the browser
     is showing the specified \p line.
     \param[in] line The line to be displayed in the middle.
+    \see topline(), middleline(), bottomline(), displayed(), lineposition()
    */
   void middleline(int line) { lineposition(line, MIDDLE); }
 
@@ -181,8 +186,10 @@ public:
   int visible(int line) const ;
 
   int value() const ;
-  /** Sets the browser's value(), which selects the specified \p line.
-      This is the same as calling select(line).
+  /**
+    Sets the browser's value(), which selects the specified \p line.
+    This is the same as calling select(line).
+    \see select(), selected(), value(), item_select(), item_selected()
    */
   void value(int line) { select(line); }
   const char* text(int line) const ;
@@ -222,25 +229,27 @@ public:
 
     Notice that the '\@.' command can be used to reliably
     terminate the parsing.  To print a random string in a random color, use 
-    <tt>sprintf("\@C%d\@.%s", color, string)</tt> and it will work even if the
+    <tt>sprintf("@C%d@.%s", color, string)</tt> and it will work even if the
     string starts with a digit or has the format character in it.
   */
   char format_char() const { return format_char_; }
   /**
     Sets the current format code prefix character to \p c.
     The default prefix is '\@'.  Set the prefix to 0 to disable formatting.
-    \see uchar Fl_Browser::format_char() const
+    \see format_char() for list of '\@' codes
   */
   void format_char(char c) { format_char_ = c; }
   /**
     Gets the current column separator character.
     The default is '\\t' (tab).
+    \see column_char(), column_widths()
   */
   char column_char() const { return column_char_; }
   /**
     Sets the column separator to c.
     This will only have an effect if you also set column_widths().
     The default is '\\t' (tab).
+    \see column_char(), column_widths()
   */
   void column_char(char c) { column_char_ = c; }
   /**
@@ -264,16 +273,23 @@ public:
   b->add("root\t13115\t0.0\t0.0\t1352\t0\ttty2\tSW\tAug30\t0:00\t@b@f/sbin/mingetty tty2");
   [..]
     \endcode
+    \see column_char(), column_widths()
   */
   const int* column_widths() const { return column_widths_; }
   /**
     Sets the current array to \p arr.  Make sure the last entry is zero.
-    \see const int *Fl_Browser::column_widths() const
+    \see column_char(), column_widths()
   */
   void column_widths(const int* arr) { column_widths_ = arr; }
 
   /**
-    Returns non-zero if \p line is visible.
+    Returns non-zero if \p line has been scrolled to a position where it is being displayed.
+    Checks to see if the item's vertical position is within the top and bottom
+    edges of the display window. This does NOT take into account the hide()/show()
+    status of the widget or item.
+    \param[in] line The line to be checked
+    \returns 1 if visible, 0 if not visible.
+    \see topline(), middleline(), bottomline(), displayed(), lineposition()
   */
   int displayed(int line) const { return Fl_Browser_::displayed(find_line(line)); }
 
@@ -282,7 +298,7 @@ public:
     Functionally similar to show(int line).
     If \p line is out of range, redisplay top or bottom of list as appropriate.
     \param[in] line The line to be made visible.
-    \see show(int)
+    \see show(int), hide(int), display(), visible(), make_visible()
   */
   void make_visible(int line) {
     if (line < 1) Fl_Browser_::display(find_line(1));
diff --git a/FL/Fl_Browser_.H b/FL/Fl_Browser_.H
index 0d150bdd9..ee977880b 100644
--- a/FL/Fl_Browser_.H
+++ b/FL/Fl_Browser_.H
@@ -89,25 +89,25 @@ protected:
   /**
     This method must be provided by the subclass 
     to return the first item in the list.
-    \see Related methods: item_first(), item_next(), item_last(), item_prev()
+    \see item_first(), item_next(), item_last(), item_prev()
    */
   virtual void *item_first() const = 0;
   /**
     This method must be provided by the subclass
     to return the item in the list after \p item.
-    \see Related methods: item_first(), item_next(), item_last(), item_prev()
+    \see item_first(), item_next(), item_last(), item_prev()
    */
   virtual void *item_next(void *item) const = 0;
   /**
     This method must be provided by the subclass
     to return the item in the list before \p item.
-    \see Related methods: item_first(), item_next(), item_last(), item_prev()
+    \see item_first(), item_next(), item_last(), item_prev()
    */
   virtual void *item_prev(void *item) const = 0;
   /**
     This method must be provided by the subclass
     to return the last item in the list.
-    \see Related methods: item_first(), item_next(), item_last(), item_prev()
+    \see item_first(), item_next(), item_last(), item_prev()
    */
   virtual void *item_last() const { return 0L; }
   /** 
@@ -116,7 +116,7 @@ protected:
     Allow for two additional pixels for the list selection box.
     \param[in] item The item whose height is returned.
     \returns The height of the specified \p item in pixels.
-    \see Related methods: item_height(), item_width(), item_quick_height()
+    \see item_height(), item_width(), item_quick_height()
   */
   virtual int item_height(void *item) const = 0;
   /**
@@ -182,7 +182,7 @@ protected:
   void redraw_line(void *item); // minimal update, no change in size
   /**
     This method will cause the entire list to be redrawn.
-    \see Related methods: redraw_lines(), redraw_line()
+    \see redraw_lines(), redraw_line()
    */
   void redraw_lines() { damage(FL_DAMAGE_SCROLL); } // redraw all of them
   void bbox(int &X,int &Y,int &W,int &H) const;
@@ -214,7 +214,7 @@ public:
     The position returned is how many pixels of the list are scrolled off the top edge
     of the screen.  Example: A position of '3' indicates the top 3 pixels of 
     the list are scrolled off the top edge of the screen.
-    \see Related methods: position(), hposition()
+    \see position(), hposition()
   */
   int position() const { return position_; }
   void position(int pos); // scroll to here
@@ -223,7 +223,7 @@ public:
     The position returned is how many pixels of the list are scrolled off the left edge
     of the screen. Example: A position of '18' indicates the left 18 pixels of
     the list are scrolled off the left edge of the screen.
-    \see Related methods: position(), hposition()
+    \see position(), hposition()
   */
   int hposition() const { return hposition_; }
   void hposition(int); // pan to here
@@ -232,14 +232,20 @@ public:
   /**
     Values for has_scrollbar().
    */
+  /** Anonymous enum bit flags for has_scrollbar().
+     -  bit 0: horizontal
+     -  bit 1: vertical
+     -  bit 2: 'always' (to be combined with bits 0 and 1)
+     -  bit 3-31: reserved for future use
+   */
   enum { // values for has_scrollbar()
-    HORIZONTAL = 1,		///< Only show horizontal scrollbar
-    VERTICAL = 2,		///< Only show vertical scrollbar
-    BOTH = 3,			///< Show both scrollbars (default)
-    ALWAYS_ON = 4,		///< Both scrollbars always on
-    HORIZONTAL_ALWAYS = 5,	///< horizontal scrollbar always on
-    VERTICAL_ALWAYS = 6,	///< vertical scrollbar always on
-    BOTH_ALWAYS = 7		///< both scrollbars always on
+    HORIZONTAL = 1,		///< Only show horizontal scrollbar.
+    VERTICAL = 2,		///< Only show vertical scrollbar.
+    BOTH = 3,			///< Show both scrollbars. (default)
+    ALWAYS_ON = 4,		///< Specified scrollbar(s) should 'always' be shown (to be used with HORIZONTAL/VERTICAL)
+    HORIZONTAL_ALWAYS = 5,	///< Horizontal scrollbar always on.
+    VERTICAL_ALWAYS = 6,	///< Vertical scrollbar always on.
+    BOTH_ALWAYS = 7		///< Both scrollbars always on.
   };
   /**
     Returns the current scrollbar mode, see Fl_Browser_::has_scrollbar(uchar)
@@ -271,7 +277,7 @@ public:
 
   /**
     Gets the default text font for the lines in the browser.
-    \see Related methods: textfont(), textsize(), textcolor()
+    \see textfont(), textsize(), textcolor()
   */
   Fl_Font textfont() const { return textfont_; }
   /**