[libexif-cvs] libexif/libexif exif-entry.h, 1.13, 1.14 exif-mem.h, 1.4, 1.5

[Hans U. N. <hu...@us...>]

Update of /cvsroot/libexif/libexif/libexif
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv21379

Modified Files:
	exif-entry.h exif-mem.h 
Log Message:
document a few things for doxygen

Index: exif-mem.h
===================================================================
RCS file: /cvsroot/libexif/libexif/libexif/exif-mem.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -p -d -r1.4 -r1.5
--- exif-mem.h	17 Jan 2006 03:32:15 -0000	1.4
+++ exif-mem.h	21 May 2007 13:53:34 -0000	1.5
@@ -1,7 +1,8 @@
 /*! \file exif-mem.h
  *  \brief Define the ExifMem data type and the associated functions.
- *  ExifMem defined the memory management functions used my the ExifLoader.
+ *  ExifMem defines the memory management functions used by the ExifLoader.
  */
+
 /* exif-mem.h
  *
  * Copyright © 2003 Lutz Müller <lu...@us...>

Index: exif-entry.h
===================================================================
RCS file: /cvsroot/libexif/libexif/libexif/exif-entry.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -p -d -r1.13 -r1.14
--- exif-entry.h	27 Apr 2005 06:45:42 -0000	1.13
+++ exif-entry.h	21 May 2007 13:53:34 -0000	1.14
@@ -1,4 +1,5 @@
-/* exif-entry.h
+/*! \file exif-entry.h
+ *  \brief Handling EXIF entries
  *
  * Copyright © 2001 Lutz Müller <lu...@us...>
  *
@@ -32,6 +33,7 @@ typedef struct _ExifEntryPrivate ExifEnt
 #include <libexif/exif-format.h>
 #include <libexif/exif-mem.h>
 
+/*! \struct _ExifEntry exif-entry.h exif/exif-entry.h */
 struct _ExifEntry {
         ExifTag tag;
         ExifFormat format;
@@ -47,19 +49,40 @@ struct _ExifEntry {
 };
 
 /* Lifecycle */
+
+/*! Reserve memory for and initialize new #ExifEntry* */
 ExifEntry  *exif_entry_new     (void);
+
 ExifEntry  *exif_entry_new_mem (ExifMem *);
+
+/*! Increase reference counter for #ExifEntry* */
 void        exif_entry_ref     (ExifEntry *entry);
+
+/*! Decrease reference counter for #ExifEntry* */
 void        exif_entry_unref   (ExifEntry *entry);
+
+/*! Actually free the #ExifEntry*
+ *
+ * \deprecated Should not be called directly. Use exif_entry_ref() and
+ *             exif_entry_unref() instead.
+ */
 void        exif_entry_free  (ExifEntry *entry);
 
 void        exif_entry_initialize (ExifEntry *entry, ExifTag tag);
 void        exif_entry_fix        (ExifEntry *entry);
 
 /* For your convenience */
+
+/*! Return the value of the EXIF entry
+ *
+ * CAUTION: The character set of the returned string is not defined.
+ *          It may be UTF-8, latin1, the native encoding of the
+ *          computer, or the native encoding of the camera.
+ */
 const char *exif_entry_get_value (ExifEntry *entry, char *val,
 				  unsigned int maxlen);
 
+/*! Dump text representation of #ExifEntry to stdout */
 void        exif_entry_dump      (ExifEntry *entry, unsigned int indent);
 
 #define exif_entry_get_ifd(e) ((e)?exif_content_get_ifd((e)->parent):EXIF_IFD_COUNT)