Use \deprecated Doxygen command where necessary

This commit is contained in:
ManoloFLTK
2019-03-26 13:57:41 +01:00
parent a67a9b0f58
commit e3e195a09c
4 changed files with 10 additions and 18 deletions
+4 -8
View File
@@ -349,20 +349,16 @@ public:
scrollbar_size_ = newSize; scrollbar_size_ = newSize;
} }
/** /**
This method has been deprecated, existing for backwards compatibility only. Returns the global value Fl::scrollbar_size().
Use scrollbar_size() instead. \deprecated Use scrollbar_size() instead.
This method always returns the global value Fl::scrollbar_size().
\returns Always returns the global value Fl::scrollbar_size().
\todo This method should eventually be removed in 1.4+ \todo This method should eventually be removed in 1.4+
*/ */
int scrollbar_width() const { int scrollbar_width() const {
return(Fl::scrollbar_size()); return(Fl::scrollbar_size());
} }
/** /**
This method has been deprecated, existing for backwards compatibility only. Sets the global Fl::scrollbar_size(), and forces this instance of the widget to use it.
Use scrollbar_size(int) instead. \deprecated Use scrollbar_size() instead.
This method sets the global Fl::scrollbar_size(), and forces this
instance of the widget to use it.
\todo This method should eventually be removed in 1.4+ \todo This method should eventually be removed in 1.4+
*/ */
void scrollbar_width(int width) { void scrollbar_width(int width) {
+4 -8
View File
@@ -224,10 +224,8 @@ public:
void cursor_color(Fl_Color n) {mCursor_color = n;} void cursor_color(Fl_Color n) {mCursor_color = n;}
/** /**
This method has been deprecated, existing for backwards compatibility only. Returns the global value Fl::scrollbar_size() unless a specific scrollbar_width_ has been set.
Use scrollbar_size() instead. \deprecated Use scrollbar_size() instead.
This method returns the global value Fl::scrollbar_size() unless
a specific scrollbar_width_ has been set.
\todo This method should eventually be removed. \todo This method should eventually be removed.
*/ */
int scrollbar_width() const { int scrollbar_width() const {
@@ -235,10 +233,8 @@ public:
} }
/** /**
This method has been deprecated, existing for backwards compatibility only. Sets the global Fl::scrollbar_size(), and forces this instance of the widget to use it.
Use scrollbar_size(int) instead. \deprecated Use scrollbar_size() instead.
This method sets the global Fl::scrollbar_size(), and forces this
instance of the widget to use it.
\todo This method should eventually be removed \todo This method should eventually be removed
*/ */
void scrollbar_width(int width) { void scrollbar_width(int width) {
+1 -1
View File
@@ -282,11 +282,11 @@ void Fl_Image::scale(int width, int height, int proportional, int can_expand)
} }
/** Draw the image to the current drawing surface rescaled to a given width and height. /** Draw the image to the current drawing surface rescaled to a given width and height.
Deprecated. Only for API compatibility with FLTK 1.3.4.
Intended for internal use by the FLTK library. Intended for internal use by the FLTK library.
\param X,Y position of the image's top-left \param X,Y position of the image's top-left
\param W,H width and height for the drawn image \param W,H width and height for the drawn image
\return 1 \return 1
\deprecated Only for API compatibility with FLTK 1.3.4.
*/ */
int Fl_Image::draw_scaled(int X, int Y, int W, int H) { int Fl_Image::draw_scaled(int X, int Y, int W, int H) {
// transiently set image drawing size to WxH // transiently set image drawing size to WxH
+1 -1
View File
@@ -91,7 +91,7 @@ Fl_RGB_Image *Fl_Image_Surface::image() {
The returned Fl_Shared_Image object is scaled to a size of WxH FLTK units and may have a The returned Fl_Shared_Image object is scaled to a size of WxH FLTK units and may have a
pixel size larger than these values. pixel size larger than these values.
The returned object should be deallocated with Fl_Shared_Image::release() after use. The returned object should be deallocated with Fl_Shared_Image::release() after use.
Deprecated: use image() instead. \deprecated Use image() instead.
\version 1.4 (1.3.4 for MacOS platform only) \version 1.4 (1.3.4 for MacOS platform only)
*/ */
Fl_Shared_Image* Fl_Image_Surface::highres_image() Fl_Shared_Image* Fl_Image_Surface::highres_image()