From 35733b87eed86e5228f12fa10c98a3d9d22a6073 Mon Sep 17 00:00:00 2001
From: scuri <scuri>
Date: Thu, 20 Aug 2009 12:13:11 +0000
Subject: *** empty log message ***

---
 src/libexif/exif-entry.h | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

(limited to 'src/libexif/exif-entry.h')

diff --git a/src/libexif/exif-entry.h b/src/libexif/exif-entry.h
index 072ee29..23731fe 100644
--- a/src/libexif/exif-entry.h
+++ b/src/libexif/exif-entry.h
@@ -1,6 +1,7 @@
-/* exif-entry.h
+/*! \file exif-entry.h
+ *  \brief Handling EXIF entries
  *
- * Copyright © 2001 Lutz Müller <lutz@users.sourceforge.net>
+ * Copyright (c) 2001 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
@@ -32,6 +33,7 @@ typedef struct _ExifEntryPrivate ExifEntryPrivate;
 #include <libexif/exif-format.h>
 #include <libexif/exif-mem.h>
 
+/*! */
 struct _ExifEntry {
         ExifTag tag;
         ExifFormat format;
@@ -47,21 +49,44 @@ 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)
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
-- 
cgit v1.2.3