added doxygen comments for undocumented features of Fl_FormsPixmap

Q. Is there a potential memory leak if Pixmap(B) called after set(b) ?



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

1 files changed, 13 insertions, 1 deletions

diff --git a/FL/Fl_FormsPixmap.H b/FL/Fl_FormsPixmap.H
index 4f054e6c9..6415bbc0a 100644
--- a/FL/Fl_FormsPixmap.H
+++ b/FL/Fl_FormsPixmap.H
@@ -33,14 +33,26 @@
 
 #include "Fl_Pixmap.H"
 
+/**
+  \class Fl_FormsPixmap
+  \brief Forms pixmap drawing routines
+*/
 class FL_EXPORT Fl_FormsPixmap : public Fl_Widget {
     Fl_Pixmap *b;
 protected:
     void draw();
 public:
-    Fl_FormsPixmap(Fl_Boxtype, int, int, int, int, const char * = 0);
+    Fl_FormsPixmap(Fl_Boxtype t, int X, int Y, int W, int H, const char *L= 0);
+
     void set(/*const*/char * const * bits);
+
+    /**
+      Set the internal pixmap pointer to an existing pixmap.
+      \param[in] B existing pixmap
+    */
     void Pixmap(Fl_Pixmap *B) {b = B;}
+
+    /** Get the internal pixmap pointer. */
     Fl_Pixmap *Pixmap() const {return b;}
 };