Improved documentation
authorDan Fandrich <dan@coneharvesters.com>
Thu, 11 Dec 2008 07:08:49 +0000 (23:08 -0800)
committerDan Fandrich <dan@coneharvesters.com>
Thu, 11 Dec 2008 07:08:49 +0000 (23:08 -0800)
NEWS
README
libexif/exif-data.c
libexif/exif-data.h
libexif/exif-loader.c

diff --git a/NEWS b/NEWS
index 0196bc5..d2fb983 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -5,7 +5,9 @@ libexif-0.6.x:
     and when each object allocated by libexif isn't used by more than one
     thread simultaneously
   * Expanded the Doxygen API documentation
-  * Fixed an Olympus MakerNote interpretation
+  * Access to the raw EXIF data through the ExifEntry structure members is
+    now officially documented
+  * Fixed some Olympus/Sanyo MakerNote interpretations
 
 libexif-0.6.17 (2008-11-06):
   * Updated translations: cs, de, pl, sk, vi
diff --git a/README b/README
index aa61618..3fc03b7 100644 (file)
--- a/README
+++ b/README
@@ -120,11 +120,13 @@ Besides the standard arguments, configure takes several specific to libexif:
 Certain specialized applications can reduce the size of the libexif
 binary by setting one or both of the following macros in the CPPFLAGS
 environment variable at configure time.  Each one removes certain kinds of
-text strings from the binary.  Applications which need to access specific,
-known EXIF tags and know in advance the meaning of their data have no need
-of those strings and can save considerable space by eliminating them.
+text strings and constants from the binary.  Applications which need
+to access specific, known EXIF tags and know in advance the meaning of
+their data have no need of those strings and can save considerable space
+by eliminating them.
 
- -DNO_VERBOSE_TAG_STRINGS Names and descriptions of EXIF tags, & debug messages
+ -DNO_VERBOSE_TAG_STRINGS Names and descriptions of EXIF tags, debug messages,
+                          mandatory EXIF fields (disabling auto-tag-fixup)
  -DNO_VERBOSE_TAG_DATA    Names of enumerated tag data contents
 
 
index 314fd8b..11d0b60 100644 (file)
@@ -341,6 +341,16 @@ if (data->ifd[(i)]->count) {                               \
        break;                                          \
 }
 
+/*! Load data for an IFD.
+ *
+ * \param[in/out] data #ExifData
+ * \param[in] ifd IFD to load
+ * \param[in] d pointer to buffer containing raw IFD data
+ * \param[in] ds size of raw data in buffer at \c d
+ * \param[in] offset offset into buffer at \c d at which IFD starts
+ * \param[in] recursion_depth number of times this function has been
+ * recursively called without returning
+ */
 static void
 exif_data_load_data_content (ExifData *data, ExifIfd ifd,
                             const unsigned char *d,
index feae15b..f0b0b66 100644 (file)
@@ -42,12 +42,15 @@ typedef struct _ExifDataPrivate ExifDataPrivate;
 #include <libexif/exif-mnote-data.h>
 #include <libexif/exif-mem.h>
 
-/*! \internal */
+/*! Represents the entire EXIF data found in an image */
 struct _ExifData
 {
        ExifContent *ifd[EXIF_IFD_COUNT];
 
+       /*! Pointer to thumbnail image, or NULL if not available */
        unsigned char *data;
+
+       /*! Number of bytes in thumbnail image at \c data */
        unsigned int size;
 
        ExifDataPrivate *priv;
index 4340369..fde75e9 100644 (file)
@@ -70,6 +70,8 @@ struct _ExifLoader {
 
        /*! Small buffer used for detection of format */
        unsigned char b[12];
+
+       /*! Number of bytes in the small buffer \c b */
        unsigned char b_len;
 
        unsigned int size;
@@ -176,6 +178,8 @@ exif_loader_write (ExifLoader *eld, unsigned char *buf, unsigned int len)
                        break;
                }
                break;
+
+       case EL_READ:
        default:
                break;
        }