diff options
| author | Ian MacArthur <imacarthur@gmail.com> | 2015-02-04 13:12:43 +0000 |
|---|---|---|
| committer | Ian MacArthur <imacarthur@gmail.com> | 2015-02-04 13:12:43 +0000 |
| commit | e402a64457289864bc1c526827cf05d0ace21f11 (patch) | |
| tree | fdb08e70b933411a0e91e8eafe6134cda1e0f135 /FL/Enumerations.H | |
| parent | 84f87addfc5afcb54c5d18bac1c97345afaa0ef7 (diff) | |
Add some doxygen descriptions for the (previously undocumented) Fl_Multi_Label struct, and make some minor related adjustments to the docs for Fl_Label and Fl_Labeltype.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10553 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Enumerations.H')
| -rw-r--r-- | FL/Enumerations.H | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/FL/Enumerations.H b/FL/Enumerations.H index 28f8d36d8..40cefc6df 100644 --- a/FL/Enumerations.H +++ b/FL/Enumerations.H @@ -3,7 +3,7 @@ // // Enumerations for the Fast Light Tool Kit (FLTK). // -// Copyright 1998-2014 by Bill Spitzak and others. +// Copyright 1998-2015 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this @@ -624,27 +624,27 @@ inline Fl_Boxtype fl_frame(Fl_Boxtype b) { /** The labeltype() method sets the type of the label. - + The following standard label types are included: - + \todo The doxygen comments are incomplete, and some labeltypes - are starting with an underscore. Also, there are three + start with an underscore. Also, there are three external functions undocumented (yet): - fl_define_FL_SHADOW_LABEL() - fl_define_FL_ENGRAVED_LABEL() - fl_define_FL_EMBOSSED_LABEL() */ enum Fl_Labeltype { // labeltypes: - FL_NORMAL_LABEL = 0, ///< draws the text (0) - FL_NO_LABEL, ///< does nothing - _FL_SHADOW_LABEL, ///< draws a drop shadow under the text - _FL_ENGRAVED_LABEL, ///< draws edges as though the text is engraved - _FL_EMBOSSED_LABEL, ///< draws edges as though the text is raised - _FL_MULTI_LABEL, ///< ? - _FL_ICON_LABEL, ///< draws the icon associated with the text - _FL_IMAGE_LABEL, ///< ? - - FL_FREE_LABELTYPE ///< first free labeltype to use for creating own labeltypes + FL_NORMAL_LABEL = 0, ///< draws the text (0) + FL_NO_LABEL, ///< does nothing + _FL_SHADOW_LABEL, ///< draws a drop shadow under the text + _FL_ENGRAVED_LABEL, ///< draws edges as though the text is engraved + _FL_EMBOSSED_LABEL, ///< draws edges as though the text is raised + _FL_MULTI_LABEL, ///< draws a composite label \see Fl_Multi_Label + _FL_ICON_LABEL, ///< draws the icon associated with the text + _FL_IMAGE_LABEL, ///< the label displays an "icon" based on a Fl_Image + + FL_FREE_LABELTYPE ///< first free labeltype to use for creating own labeltypes }; /** |