Fix documentation of FL/Fl_Box.H

This commit is contained in:
Albrecht Schlosser 2023-02-02 19:14:14 +01:00
parent 32b6c04bcf
commit 796ff44268

View File

@ -1,7 +1,7 @@
// //
// Box header file for the Fast Light Tool Kit (FLTK). // Box header file for the Fast Light Tool Kit (FLTK).
// //
// Copyright 1998-2010 by Bill Spitzak and others. // Copyright 1998-2023 by Bill Spitzak and others.
// //
// This library is free software. Distribution and use rights are outlined in // 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 // the file "COPYING" which should have been included with this file. If this
@ -14,8 +14,9 @@
// https://www.fltk.org/bugs.php // https://www.fltk.org/bugs.php
// //
/* \file /** \file FL/Fl_Box.H
Fl_Box widget . */ \brief Fl_Box widget.
*/
#ifndef Fl_Box_H #ifndef Fl_Box_H
#define Fl_Box_H #define Fl_Box_H
@ -34,13 +35,12 @@ protected:
void draw() FL_OVERRIDE; void draw() FL_OVERRIDE;
public: public:
/** /**
- The first constructor sets box() to FL_NO_BOX, which - The first constructor sets box() to FL_NO_BOX, which means it is invisible.
means it is invisible. However such widgets are useful as placeholders However such widgets are useful as placeholders or Fl_Group::resizable()
or Fl_Group::resizable() values. To change the box to something visible, use box(n).
values. To change the box to something visible, use box(n). - The second form of the constructor sets the box to the specified box type.
- The second form of the constructor sets the box to the specified box
type. The destructor removes the box.
<P>The destructor removes the box.
*/ */
Fl_Box(int X, int Y, int W, int H, const char *l=0); Fl_Box(int X, int Y, int W, int H, const char *l=0);