Documented some return values in the case of errors.

[platform/upstream/libexif.git] / libexif / exif-mem.h

diff --git a/libexif/exif-mem.h b/libexif/exif-mem.h
index c726034..93bf705 100644 (file)
--- a/libexif/exif-mem.h
+++ b/libexif/exif-mem.h
@@ -1,6 +1,10 @@
+/*! \file exif-mem.h
+ *  \brief Define the ExifMem data type and the associated functions.
+ *  ExifMem defines the memory management functions used within libexif.
+ */
 /* exif-mem.h
  *
- * Copyright © 2003 Lutz Müller <lutz@users.sourceforge.net>
+ * Copyright (c) 2003 Lutz Mueller <lutz@users.sourceforge.net>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -14,8 +18,8 @@
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA  02110-1301  USA.
  */
 
 #ifndef __EXIF_MEM_H__
@@ -27,22 +31,57 @@
 extern "C" {
 #endif /* __cplusplus */
 
-typedef void * (* ExifMemAllocFunc)   (ExifLong);
-typedef void * (* ExifMemReallocFunc) (void *, ExifLong);
-typedef void   (* ExifMemFreeFunc)    (void *);
+/*! Should work like calloc()
+ *
+ *  \param[in] s the size of the block to allocate.
+ *  \return the allocated memory and initialized. 
+ */
+typedef void * (* ExifMemAllocFunc)   (ExifLong s);
+
+/*! Should work like realloc()
+ *
+ * \param[in] p the pointer to reallocate
+ * \param[in] s the size of the reallocated block
+ * \return allocated memory 
+ */
+typedef void * (* ExifMemReallocFunc) (void *p, ExifLong s);
+
+/*! Free method for ExifMem
+ *
+ * \param[in] p the pointer to free
+ * \return the freed pointer
+ */
+typedef void   (* ExifMemFreeFunc)    (void *p);
 
+/*! ExifMem define a memory allocator */
 typedef struct _ExifMem ExifMem;
 
-ExifMem *exif_mem_new   (ExifMemAllocFunc, ExifMemReallocFunc,
-                        ExifMemFreeFunc);
+/*! Create a new ExifMem
+ *
+ * \param[in] a the allocator function
+ * \param[in] r the reallocator function
+ * \param[in] f the free function
+ * \return allocated #ExifMem, or NULL on error
+ */
+ExifMem *exif_mem_new   (ExifMemAllocFunc a, ExifMemReallocFunc r,
+                        ExifMemFreeFunc f);
+/*! Refcount an ExifMem
+ */
 void     exif_mem_ref   (ExifMem *);
+
+/*! Unrefcount an ExifMem.
+ * If the refcount reaches 0, the ExifMem is freed
+ */
 void     exif_mem_unref (ExifMem *);
 
-void *exif_mem_alloc   (ExifMem *, ExifLong);
-void *exif_mem_realloc (ExifMem *, void *, ExifLong);
-void  exif_mem_free    (ExifMem *, void *);
+void *exif_mem_alloc   (ExifMem *m, ExifLong s);
+void *exif_mem_realloc (ExifMem *m, void *p, ExifLong s);
+void  exif_mem_free    (ExifMem *m, void *p);
 
-/* For your convenience */
+/*! Create a new ExifMem with default values for your convenience
+ *
+ * \return return a new default ExifMem
+ */
 ExifMem *exif_mem_new_default (void);
 
 #ifdef __cplusplus