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

View File

@ -349,20 +349,16 @@ public:
scrollbar_size_ = newSize;
}
/**
This method has been deprecated, existing for backwards compatibility only.
Use scrollbar_size() instead.
This method always returns the global value Fl::scrollbar_size().
\returns Always returns the global value Fl::scrollbar_size().
Returns the global value Fl::scrollbar_size().
\deprecated Use scrollbar_size() instead.
\todo This method should eventually be removed in 1.4+
*/
int scrollbar_width() const {
return(Fl::scrollbar_size());
}
/**
This method has been deprecated, existing for backwards compatibility only.
Use scrollbar_size(int) instead.
This method sets the global Fl::scrollbar_size(), and forces this
instance of the widget to use it.
Sets the global Fl::scrollbar_size(), and forces this instance of the widget to use it.
\deprecated Use scrollbar_size() instead.
\todo This method should eventually be removed in 1.4+
*/
void scrollbar_width(int width) {

View File

@ -224,10 +224,8 @@ public:
void cursor_color(Fl_Color n) {mCursor_color = n;}
/**
This method has been deprecated, existing for backwards compatibility only.
Use scrollbar_size() instead.
This method returns the global value Fl::scrollbar_size() unless
a specific scrollbar_width_ has been set.
Returns the global value Fl::scrollbar_size() unless a specific scrollbar_width_ has been set.
\deprecated Use scrollbar_size() instead.
\todo This method should eventually be removed.
*/
int scrollbar_width() const {
@ -235,10 +233,8 @@ public:
}
/**
This method has been deprecated, existing for backwards compatibility only.
Use scrollbar_size(int) instead.
This method sets the global Fl::scrollbar_size(), and forces this
instance of the widget to use it.
Sets the global Fl::scrollbar_size(), and forces this instance of the widget to use it.
\deprecated Use scrollbar_size() instead.
\todo This method should eventually be removed
*/
void scrollbar_width(int width) {

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.
Deprecated. Only for API compatibility with FLTK 1.3.4.
Intended for internal use by the FLTK library.
\param X,Y position of the image's top-left
\param W,H width and height for the drawn image
\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) {
// transiently set image drawing size to WxH

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
pixel size larger than these values.
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)
*/
Fl_Shared_Image* Fl_Image_Surface::highres_image()