Documentation updates (remaining fix for STR #2520).

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

View File

@ -3,7 +3,7 @@
//
// 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.
//
// This library is free software; you can redistribute it and/or
@ -274,12 +274,9 @@ static void jpeg_mem_src(j_decompress_ptr cinfo, const unsigned char *data)
There is no error function in this class. If the image has loaded correctly,
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!
\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.
\param data A pointer to the memory location of the JPEG image
*/
Fl_JPEG_Image::Fl_JPEG_Image(const char *name, const unsigned char *data)
: Fl_RGB_Image(0,0,0) {

View File

@ -3,7 +3,7 @@
//
// 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.
//
// 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.
<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.
\param[in] filename Name of PNG file to read
*/
Fl_PNG_Image::Fl_PNG_Image (const char *filename): Fl_RGB_Image(0,0,0)
{
@ -87,6 +90,7 @@ Fl_PNG_Image::Fl_PNG_Image (const char *filename): Fl_RGB_Image(0,0,0)
}
/** Constructor that reads a PNG image from memory.
\param name_png A name given to this image
\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