fix API doc

This commit is contained in:
HumanDynamo 2008-08-02 10:10:02 +00:00
parent 65feff805c
commit 31ed169623
3 changed files with 13 additions and 5 deletions

View File

@ -75,6 +75,9 @@ namespace Exiv2
auto-pointer. Callers should not continue to use the BasicIo
instance after it is passed to this method. Use the Image::io()
method to get a temporary reference.
@param create Specifies if an existing image should be read (false)
or if a new file should be created (true).
This option is not yet implemented.
*/
Jp2Image(BasicIo::AutoPtr io, bool create);
//@}

View File

@ -64,7 +64,9 @@ namespace Exiv2
{
public:
// Text Chunk types.
/*!
@brief Text Chunk types.
*/
enum TxtChunkType
{
tEXt_Chunk = 0,
@ -72,7 +74,9 @@ namespace Exiv2
iTXt_Chunk = 2
};
// Metadata Chunk types.
/*!
@brief Metadata Chunk types.
*/
enum MetadataType
{
exif_Data = 0,
@ -87,7 +91,7 @@ namespace Exiv2
@brief Decode PNG IHDR chunk data from a data buffer
\em data and return image size to \em outWidth and \em outHeight.
@param pData PNG Chunk data buffer.
@param data PNG Chunk data buffer.
@param outWidth Integer pointer to be set to the width of the image.
@param outHeight Integer pointer to be set to the height of the image.
*/
@ -117,9 +121,9 @@ namespace Exiv2
/*!
@brief Return a complete PNG chunk data compressed or not as buffer. Data returned is formated
accordingly with metadata \em type to host passed by \em data.
accordingly with metadata \em type to host passed by \em metadata.
@param data metadata buffer.
@param metadata metadata buffer.
@param type metadata type.
@param compress compress or not metadata.
*/

View File

@ -79,6 +79,7 @@ namespace Exiv2
method to get a temporary reference.
@param create Specifies if an existing image should be read (false)
or if a new file should be created (true).
This option is not yet implemented.
*/
PngImage(BasicIo::AutoPtr io, bool create);
//@}