[trunk] WIP: add a read CBD marker function (JPEG2000 part 2)

[openjpeg.git] / libopenjpeg / image.h

diff --git a/libopenjpeg/image.h b/libopenjpeg/image.h
index cb6ad650c597eeb5ed4d3a846bfd98636f8dfd07..98e918e57d8e59f829966c839d2beb0100797e29 100644 (file)
--- a/libopenjpeg/image.h
+++ b/libopenjpeg/image.h
@@ -39,19 +39,21 @@ struct opj_cp_v2;
 /*@{*/
 
 /**
-Create an empty image
-@todo this function should be removed
-@return returns an empty image if successful, returns NULL otherwise
-*/
+ * Create an empty image
+ *
+ * @return returns an empty image if successful, returns NULL otherwise
+ */
 opj_image_t* opj_image_create0(void);
 
+
+
 /**
- * Updates the components of the image from the coding parameters.
+ * Updates the components characteristics of the image from the coding parameters.
  *
- * @param p_image              the image to update.
- * @param p_cp                 the coding parameters from which to update the image.
+ * @param p_image_header               the image header to update.
+ * @param p_cp                                 the coding parameters from which to update the image.
  */
-void opj_image_comp_update(struct opj_image * p_image,const struct opj_cp_v2 * p_cp);
+void opj_image_comp_header_update(opj_image_t * p_image, const struct opj_cp_v2* p_cp);
 
 /*@}*/