summaryrefslogtreecommitdiff
path: root/FL/Fl_Bitmap.H
diff options
context:
space:
mode:
authorengelsman <engelsman>2008-09-20 14:29:29 +0000
committerengelsman <engelsman>2008-09-20 14:29:29 +0000
commitf5a1576d7ca95ae7ca2ceb96fb53a7bc34fea20b (patch)
tree4c150a09159211af304dd559d81cc3e5ff0da205 /FL/Fl_Bitmap.H
parent40a156aa94454fa2e3c5c8639dd476c06f51b737 (diff)
added doxygen comments for undocumented methods of Fl_Bitmap and Fl_Browser
also replaced some html with doxygen equivalent. note that not all comments are consistent. some are one-liners, even though the contain [obvious?] parameters, and others have \param and \returns. note too, that some parameter names are ambiguous and require type info, eg line could be FL_BLINE* for whole line entry, or int for line number, and this can make descriptions awkward (\param line line number). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6318 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Bitmap.H')
-rw-r--r--FL/Fl_Bitmap.H10
1 files changed, 7 insertions, 3 deletions
diff --git a/FL/Fl_Bitmap.H b/FL/Fl_Bitmap.H
index 5e0028c23..0df5ab23b 100644
--- a/FL/Fl_Bitmap.H
+++ b/FL/Fl_Bitmap.H
@@ -42,12 +42,16 @@ struct Fl_Menu_Item;
class FL_EXPORT Fl_Bitmap : public Fl_Image {
public:
+ /** pointer to raw bitmap data */
const uchar *array;
- int alloc_array; // Non-zero if data was allocated
+ /** Non-zero if array points to bitmap data allocated internally */
+ int alloc_array;
#if defined(__APPLE__) || defined(WIN32)
- void *id; // for internal use
+ /** for internal use */
+ void *id;
#else
- unsigned id; // for internal use
+ /** for internal use */
+ unsigned id;
#endif // __APPLE__ || WIN32
/** The constructors create a new bitmap from the specified bitmap data */
Fl_Bitmap(const uchar *bits, int W, int H) :