From 4bc22ed15d3ed21d49ce96e57412e2bfc9d0261c Mon Sep 17 00:00:00 2001 From: engelsman Date: Sun, 21 Sep 2008 08:00:32 +0000 Subject: [PATCH] doxygen comments for undocumented features of Fl_Clock, Fl_Check_Browser git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6327 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Check_Browser.H | 11 ++++++----- FL/Fl_Clock.H | 14 +++++++++----- src/Fl_Clock.cxx | 7 +++++++ 3 files changed, 22 insertions(+), 10 deletions(-) diff --git a/FL/Fl_Check_Browser.H b/FL/Fl_Check_Browser.H index f44665466..c702d6c6f 100644 --- a/FL/Fl_Check_Browser.H +++ b/FL/Fl_Check_Browser.H @@ -54,12 +54,13 @@ class FL_EXPORT Fl_Check_Browser : public Fl_Browser_ { public: // IRIX 5.3 C++ compiler doesn't support private structures... + /** For internal use only. */ struct cb_item { - cb_item *next; - cb_item *prev; - char checked; - char selected; - char *text; + cb_item *next; /**< For internal use only. */ + cb_item *prev; /**< For internal use only. */ + char checked; /**< For internal use only. */ + char selected; /**< For internal use only. */ + char *text; /**< For internal use only. */ }; private: diff --git a/FL/Fl_Clock.H b/FL/Fl_Clock.H index ada853a22..2d21e1f14 100644 --- a/FL/Fl_Clock.H +++ b/FL/Fl_Clock.H @@ -36,10 +36,10 @@ #endif // values for type: -#define FL_SQUARE_CLOCK 0 -#define FL_ROUND_CLOCK 1 -#define FL_ANALOG_CLOCK FL_SQUARE_CLOCK -#define FL_DIGITAL_CLOCK FL_SQUARE_CLOCK // nyi +#define FL_SQUARE_CLOCK 0 /**< type() of Square Clock variant */ +#define FL_ROUND_CLOCK 1 /**< type() of Round Clock variant */ +#define FL_ANALOG_CLOCK FL_SQUARE_CLOCK /**< An analog clock is square */ +#define FL_DIGITAL_CLOCK FL_SQUARE_CLOCK /**< Not yet implemented */ /** \class Fl_Clock_Output @@ -57,8 +57,8 @@ class FL_EXPORT Fl_Clock_Output : public Fl_Widget { ulong value_; void drawhands(Fl_Color,Fl_Color); // part of draw protected: - void draw(int, int, int, int); void draw(); + void draw(int X, int Y, int W, int H); public: Fl_Clock_Output(int X, int Y, int W, int H, const char *L = 0); @@ -109,6 +109,10 @@ public: class FL_EXPORT Fl_Clock : public Fl_Clock_Output { public: int handle(int); + /** + Undefined. + \todo Find Fl_Clock::update() implementation, if any, and document it. + */ void update(); Fl_Clock(int X, int Y, int W, int H, const char *L = 0); diff --git a/src/Fl_Clock.cxx b/src/Fl_Clock.cxx index b13223c5e..ec2020c4a 100644 --- a/src/Fl_Clock.cxx +++ b/src/Fl_Clock.cxx @@ -74,6 +74,10 @@ static void rect(double x, double y, double w, double h) { fl_end_polygon(); } +/** + Draw clock with the given position and size. + \param[in] X, Y, W, H position and size +*/ void Fl_Clock_Output::draw(int X, int Y, int W, int H) { Fl_Color box_color = type()==FL_ROUND_CLOCK ? FL_GRAY : color(); Fl_Color shadow_color = fl_color_average(box_color, FL_BLACK, 0.5); @@ -107,6 +111,9 @@ void Fl_Clock_Output::draw(int X, int Y, int W, int H) { fl_pop_matrix(); } +/** + Draw clock with current position and size. +*/ void Fl_Clock_Output::draw() { draw(x(), y(), w(), h()); draw_label();