A few in-code documentation improvements

diff --git a/NEWS b/NEWS
index d342682..305cdf7 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,6 @@
 libexif-0.6.x:
-  *
+  * Added more supported lens in Canon MakerNote
+  * Added some defensive NULL pointer checks
 
 libexif-0.6.20 (2010-12-15):
   * New translations: bs, tr

diff --git a/libexif/exif-byte-order.h b/libexif/exif-byte-order.h
index ab5c9ad..10ded49 100644 (file)
--- a/libexif/exif-byte-order.h
+++ b/libexif/exif-byte-order.h
@@ -1,5 +1,7 @@
-/* exif-byte-order.h
- *
+/*! \file exif-byte-order.h
+ * \brief Defines the ExifByteOrder enum and the associated functions.
+ */
+/* 
  * Copyright (c) 2002 Lutz Mueller <lutz@users.sourceforge.net>
  *
  * This library is free software; you can redistribute it and/or

diff --git a/libexif/exif-data.h b/libexif/exif-data.h
index 1bcc4e5..eeee782 100644 (file)
--- a/libexif/exif-data.h
+++ b/libexif/exif-data.h
@@ -95,8 +95,9 @@ ExifData *exif_data_new_from_data (const unsigned char *data,
 /*! Load the #ExifData structure from the raw JPEG or EXIF data in the given
  * memory buffer. If the EXIF data contains a recognized MakerNote, it is
  * loaded and stored as well for later retrieval by #exif_data_get_mnote_data.
- * If the EXIF_DATA_OPTION_FOLLOW_SPECIFICATION has been set on this #ExifData,
- * then the tags are fixed after loading.
+ * If the #EXIF_DATA_OPTION_FOLLOW_SPECIFICATION option has been set on this
+ * #ExifData, then the tags are automatically fixed after loading (by calling
+ * #exif_data_fix).
  *
  * \param[in,out] data EXIF data
  * \param[in] d pointer to raw JPEG or EXIF data

diff --git a/libexif/exif-entry.c b/libexif/exif-entry.c
index a7edf7a..58a008f 100644 (file)
--- a/libexif/exif-entry.c
+++ b/libexif/exif-entry.c
@@ -433,9 +433,10 @@ exif_entry_fix (ExifEntry *e)
 }
 
 /*! Format the value of an ExifEntry for human display in a generic way.
- * The output is localized. The formatting is independent of the tag number.
+ * The output is localized. The formatting is independent of the tag number
+ * and is based entirely on the data type.
  * \pre The buffer at val is entirely cleared to 0. This guarantees that the
- *      resulting string will be NUL terminated.
+ *      resulting string will be NUL terminated. FIXME: relax this requirement
  * \pre The ExifEntry is already a member of an ExifData.
  * \param[in] e EXIF entry
  * \param[out] val buffer in which to store value