diff options
| author | engelsman <engelsman> | 2008-09-21 13:20:12 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2008-09-21 13:20:12 +0000 |
| commit | a4b0ac592e12036425f43f0570bfed5a781ff215 (patch) | |
| tree | 26231c6883d3d97a97ae21a14087f5a151011136 | |
| parent | c7921f06ad8480e18f74b89f326ac9f73e0ddefa (diff) | |
doxygen comments for undocumented features of Fl_Color_Browser
added comment for mode() and enum {M_RGB, ...} but now I can't find the
latter on the genrated pages. What have I done wrong?
Also added #ifndef FL_DOXYGEN around the Flcc_* helper classes so they
won't appear in the docs, or cause undocumented warnings from doxygen.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6331 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
| -rw-r--r-- | FL/Fl_Color_Chooser.H | 8 | ||||
| -rw-r--r-- | src/Fl_Color_Chooser.cxx | 8 |
2 files changed, 15 insertions, 1 deletions
diff --git a/FL/Fl_Color_Chooser.H b/FL/Fl_Color_Chooser.H index 66d0f16f0..8a9372f9d 100644 --- a/FL/Fl_Color_Chooser.H +++ b/FL/Fl_Color_Chooser.H @@ -41,6 +41,9 @@ #include <FL/Fl_Choice.H> #include <FL/Fl_Value_Input.H> +#ifndef FL_DOXYGEN + +/** For internal use only */ class FL_EXPORT Flcc_HueBox : public Fl_Widget { int px, py; protected: @@ -52,6 +55,7 @@ public: px = py = 0;} }; +/** For internal use only */ class FL_EXPORT Flcc_ValueBox : public Fl_Widget { int py; protected: @@ -63,12 +67,15 @@ public: py = 0;} }; +/** For internal use only */ class FL_EXPORT Flcc_Value_Input : public Fl_Value_Input { public: int format(char*); Flcc_Value_Input(int X, int Y, int W, int H) : Fl_Value_Input(X,Y,W,H) {} }; +#endif // !FL_DOXYGEN + /** \class Fl_Color_Chooser \brief The Fl_Color_Chooser widget provides a standard RGB color chooser. @@ -115,6 +122,7 @@ class FL_EXPORT Fl_Color_Chooser : public Fl_Group { static void rgb_cb(Fl_Widget*, void*); static void mode_cb(Fl_Widget*, void*); public: + /** Returns which Fl_Color_Chooser variant is currently active */ int mode() {return choice.value();} /** diff --git a/src/Fl_Color_Chooser.cxx b/src/Fl_Color_Chooser.cxx index d06393e16..fe7e46b02 100644 --- a/src/Fl_Color_Chooser.cxx +++ b/src/Fl_Color_Chooser.cxx @@ -93,7 +93,13 @@ void Fl_Color_Chooser::rgb2hsv( } } -enum {M_RGB, M_BYTE, M_HEX, M_HSV}; // modes +/** Fl_Color_Chooser modes */ +enum { + M_RGB, /**< mode() of Fl_Color_Chooser showing RGB values */ + M_BYTE, /**< mode() of Fl_Color_Chooser showing byte values */ + M_HEX, /**< mode() of Fl_Color_Chooser showing hex values */ + M_HSV /**< mode() of Fl_Color_Chooser showing HSV values */ +}; static Fl_Menu_Item mode_menu[] = { {"rgb"}, {"byte"}, |