Doxygen doc: minor rewording for the Fl_SVG_Image class.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12539 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Manolo Gouy
2017-11-03 09:04:56 +00:00
parent 127147ca97
commit 3d53e5b496
2 changed files with 8 additions and 8 deletions
+2 -2
View File
@@ -122,9 +122,9 @@ protected:
virtual int draw_scaled(int X, int Y, int W, int H);
public:
/** Set this to \c false to allow image re-scaling that alters the image aspect ratio.
Upon object creation, \c proportional is set to \c true, and the aspect ratio is kept constant.*/
Upon object creation, proportional is set to \c true, and the aspect ratio is kept constant.*/
bool proportional;
Fl_SVG_Image(const char *filename, const char *filedata = NULL);
Fl_SVG_Image(const char *filename, const char *svg_data = NULL);
virtual ~Fl_SVG_Image();
virtual Fl_Image *copy(int W, int H);
void resize(int width, int height);
+6 -6
View File
@@ -45,13 +45,13 @@ static double strtoll(const char *str, char **endptr, int base) {
/** The constructor loads the SVG image from the given .svg/.svgz filename or in-memory data.
\param filename A full path and name pointing to a .svg or .svgz file, or NULL.
\param filedata A pointer to the memory location of the SVG image data.
\param filename The full path and name of a .svg or .svgz file, or NULL.
\param svg_data A pointer to the memory location of the SVG image data.
This parameter allows to load an SVG image from in-memory data, and is used when \p filename is NULL.
\note In-memory SVG data is parsed by the object constructor and is no longer used after construction.
\note In-memory SVG data is parsed by the object constructor and is not used after construction.
*/
Fl_SVG_Image::Fl_SVG_Image(const char *filename, const char *filedata) : Fl_RGB_Image(NULL, 0, 0, 4) {
init_(filename, filedata, NULL);
Fl_SVG_Image::Fl_SVG_Image(const char *filename, const char *svg_data) : Fl_RGB_Image(NULL, 0, 0, 4) {
init_(filename, svg_data, NULL);
}
@@ -208,7 +208,7 @@ Fl_Image *Fl_SVG_Image::copy(int W, int H) {
/** Have the svg data (re-)rasterized using the given width and height values.
By default, the resulting image w() and h() will preserve the width/height ratio
of the SVG data.
If \ref proportional was set to false, the image is rasterized to the given \c width
If \ref proportional was set to \c false, the image is rasterized to the given \c width
and \c height values.*/
void Fl_SVG_Image::resize(int width, int height) {
if (ld() < 0) {