From 31ed1696234eaeeb9bd87cce90d005c04f520609 Mon Sep 17 00:00:00 2001
From: HumanDynamo <caulier.gilles@gmail.com>
Date: Sat, 2 Aug 2008 10:10:02 +0000
Subject: [PATCH] fix API doc

---
 src/jp2image.hpp |  3 +++
 src/pngchunk.hpp | 14 +++++++++-----
 src/pngimage.hpp |  1 +
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/src/jp2image.hpp b/src/jp2image.hpp
index 513deccf..2de69799 100644
--- a/src/jp2image.hpp
+++ b/src/jp2image.hpp
@@ -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);
         //@}
diff --git a/src/pngchunk.hpp b/src/pngchunk.hpp
index 0fab7525..67db00f5 100644
--- a/src/pngchunk.hpp
+++ b/src/pngchunk.hpp
@@ -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.
         */
diff --git a/src/pngimage.hpp b/src/pngimage.hpp
index a7212bb9..fbb9384a 100644
--- a/src/pngimage.hpp
+++ b/src/pngimage.hpp
@@ -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);
         //@}