Doxygen documentation : minor comment fixes.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6365 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Fabien Costantini 2008-10-03 07:48:38 +00:00
parent a95a1f01a9
commit bd882119e7
7 changed files with 18 additions and 11 deletions

View File

@ -68,8 +68,9 @@ public:
// access attributes
cairo_t* cc() const {return cc_;} ///< Gets the current cairo context
bool autolink() const {return autolink_;} ///< Sets the autolink option \see Fl::cairo_autolink_context(bool)
void cc(cairo_t* c, bool own=true) { ///< Sets the current cairo context, \a own indicates cc deletion is made by us
bool autolink() const {return autolink_;} ///< Sets the autolink option. See Fl::cairo_autolink_context(bool)
/** Sets the current cairo context, \a own indicates cc deletion is handle externally by user */
void cc(cairo_t* c, bool own=true) {
if (cc_ && own_cc_) cairo_destroy(cc_);
cc_=c;
if (!cc_) window_=0;

View File

@ -72,10 +72,6 @@ struct FL_EXPORT Fl_Label {
unsigned color;
/** draw the label aligned to the given box */
void draw(int,int,int,int, Fl_Align) const ;
/** measure the size of the label.
* \param w, h on input, this is the requested size for the label text plus image;
* on return, this will contain the size needed to fit the label
*/
void measure(int &w, int &h) const ;
};

View File

@ -548,7 +548,9 @@ int Fl::ready() {
////////////////////////////////////////////////////////////////
// Window list management:
#ifndef FL_DOXYGEN
Fl_X* Fl_X::first;
#endif
Fl_Window* fl_find(Window xid) {
Fl_X *window;

View File

@ -104,8 +104,8 @@ void Fl_Dial::draw() {
}
/**
Allow subclasses to handle event based on given position and size.
\param[in] X, Y, W, H position and size
Allows subclasses to handle event based on given position and size.
\param[in] event, X, Y, W, H event to handle, related position and size.
*/
int Fl_Dial::handle(int event, int X, int Y, int W, int H) {
switch (event) {

View File

@ -69,7 +69,9 @@ Fl_Text_Editor::Fl_Text_Editor(int X, int Y, int W, int H, const char* l)
default_key_function(kf_default);
}
#ifndef FL_DOXYGEN
Fl_Text_Editor::Key_Binding* Fl_Text_Editor::global_key_bindings = 0;
#endif
// These are the default key bindings every widget should start with
static struct {

View File

@ -263,8 +263,10 @@ extern void fl_down_frame(int, int, int, int, Fl_Color);
extern void fl_thin_up_frame(int, int, int, int, Fl_Color);
extern void fl_thin_down_frame(int, int, int, int, Fl_Color);
const char *Fl::scheme_ = (const char *)0; ///< current scheme
Fl_Image *Fl::scheme_bg_ = (Fl_Image *)0; ///< current background image for the scheme
#ifndef FL_DOXYGEN
const char *Fl::scheme_ = (const char *)0; // current scheme
Fl_Image *Fl::scheme_bg_ = (Fl_Image *)0; // current background image for the scheme
#endif
static Fl_Pixmap tile(tile_xpm);

View File

@ -87,7 +87,11 @@ void Fl_Label::draw(int X, int Y, int W, int H, Fl_Align align) const {
if (!value && !image) return;
table[type](this, X, Y, W, H, align);
}
/** Gets the size of the label W and H contains the calculated size at return. */
/**
Measures the size of the label.
\param W, H in out : this is the requested size for the label text plus image;
on return, this will contain the size needed to fit the label
*/
void Fl_Label::measure(int& W, int& H) const {
if (!value && !image) {
W = H = 0;