mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation updates (remaining fix for STR #2520).

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8288 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2011-01-17 22:42:34 +00:00
parent 0ae1054d07
commit b841d90d3c
2 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/Fl_JPEG_Image.cxx
View File

@ -3,7 +3,7 @@
// //
// Fl_JPEG_Image routines. // Fl_JPEG_Image routines.
// //
// Copyright 1997-2010 by Easy Software Products. // Copyright 1997-2011 by Easy Software Products.
// Image support by Matthias Melcher, Copyright 2000-2009. // Image support by Matthias Melcher, Copyright 2000-2009.
// //
// This library is free software; you can redistribute it and/or // This library is free software; you can redistribute it and/or
@ -267,19 +267,16 @@ static void jpeg_mem_src(j_decompress_ptr cinfo, const unsigned char *data)
/** /**
\brief The constructor loads the JPEG image from memory. \brief The constructor loads the JPEG image from memory.
The inherited destructor frees all memory and server resources that are used The inherited destructor frees all memory and server resources that are used
by the image. by the image.
There is no error function in this class. If the image has loaded correctly, There is no error function in this class. If the image has loaded correctly,
w(), h(), and d() should return values greater zero. w(), h(), and d() should return values greater zero.
\param name developer should provide a unique name for this image. \param name The developer should provide a unique name for this image.
Note: currently this is not used! Note: currently this is not used!
\param data a pointer to the memory location of the jpeg image \param data A pointer to the memory location of the JPEG image
\todo The documentation of parameter \p name specifies that a unique name
should be provided, but it is not used in the constructor.
*/ */
Fl_JPEG_Image::Fl_JPEG_Image(const char *name, const unsigned char *data) Fl_JPEG_Image::Fl_JPEG_Image(const char *name, const unsigned char *data)
: Fl_RGB_Image(0,0,0) { : Fl_RGB_Image(0,0,0) {

10
src/Fl_PNG_Image.cxx
View File

@ -3,7 +3,7 @@
// //
// Fl_PNG_Image routines. // Fl_PNG_Image routines.
// //
// Copyright 1997-2010 by Easy Software Products. // Copyright 1997-2011 by Easy Software Products.
// Image support by Matthias Melcher, Copyright 2000-2009. // Image support by Matthias Melcher, Copyright 2000-2009.
// //
// This library is free software; you can redistribute it and/or // This library is free software; you can redistribute it and/or
@ -78,8 +78,11 @@ static void png_read_data_from_mem( png_structp png_ptr, //pointer to our data
/** /**
The constructor loads the named PNG image from the given png filename. The constructor loads the named PNG image from the given png filename.
<P>The destructor frees all memory and server resources that are used by
The destructor frees all memory and server resources that are used by
the image. the image.
\param[in] filename Name of PNG file to read
*/ */
Fl_PNG_Image::Fl_PNG_Image (const char *filename): Fl_RGB_Image(0,0,0) Fl_PNG_Image::Fl_PNG_Image (const char *filename): Fl_RGB_Image(0,0,0)
{ {
@ -87,8 +90,9 @@ Fl_PNG_Image::Fl_PNG_Image (const char *filename): Fl_RGB_Image(0,0,0)
} }
/** Constructor that reads a PNG image from memory. /** Constructor that reads a PNG image from memory.
\param name_png A name given to this image \param name_png A name given to this image
\param buffer Pointer to the start of the PNG image in memory \param buffer Pointer to the start of the PNG image in memory
\param maxsize Size in bytes of the memory buffer containing the PNG image \param maxsize Size in bytes of the memory buffer containing the PNG image
*/ */
Fl_PNG_Image::Fl_PNG_Image ( Fl_PNG_Image::Fl_PNG_Image (