Author: AlbrechtS
Date: 2011-01-17 14:42:34 -0800 (Mon, 17 Jan 2011)
New Revision: 8288
Log:
Documentation updates (remaining fix for STR #2520).
Modified:
branches/branch-1.3/src/Fl_JPEG_Image.cxx
branches/branch-1.3/src/Fl_PNG_Image.cxx
Modified: branches/branch-1.3/src/Fl_JPEG_Image.cxx
===================================================================
--- branches/branch-1.3/src/Fl_JPEG_Image.cxx 2011-01-17 20:51:12 UTC (rev
8287)
+++ branches/branch-1.3/src/Fl_JPEG_Image.cxx 2011-01-17 22:42:34 UTC (rev
8288)
@@ -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
@@ -267,19 +267,16 @@
/**
\brief The constructor loads the JPEG image from memory.
-
+
The inherited destructor frees all memory and server resources that are used
by the image.
-
+
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) {
Modified: branches/branch-1.3/src/Fl_PNG_Image.cxx
===================================================================
--- branches/branch-1.3/src/Fl_PNG_Image.cxx 2011-01-17 20:51:12 UTC (rev
8287)
+++ branches/branch-1.3/src/Fl_PNG_Image.cxx 2011-01-17 22:42:34 UTC (rev
8288)
@@ -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 @@
/**
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,8 +90,9 @@
}
/** 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 buffer Pointer to the start of the PNG image in memory
\param maxsize Size in bytes of the memory buffer containing the PNG image
*/
Fl_PNG_Image::Fl_PNG_Image (
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
