Updated Doxygen comments
authorDan Fandrich <dan@coneharvesters.com>
Sat, 3 Jan 2009 08:19:20 +0000 (00:19 -0800)
committerDan Fandrich <dan@coneharvesters.com>
Sat, 3 Jan 2009 08:19:20 +0000 (00:19 -0800)
libexif/exif-content.h
libexif/exif-mnote-data.h

index f6e738e..b7a200b 100644 (file)
@@ -72,6 +72,8 @@ void         exif_content_add_entry    (ExifContent *c, ExifEntry *entry);
 void         exif_content_remove_entry (ExifContent *c, ExifEntry *e);
 
 /*! Return the #ExifEntry in this IFD corresponding to the given tag.
+ * This is a pointer into a member of the #ExifContent array and must NOT be
+ * freed by the caller.
  *
  * \param[in] content EXIF content for an IFD
  * \param[in] tag EXIF tag to return
index 8e034d1..89f51a3 100644 (file)
@@ -77,15 +77,16 @@ unsigned int exif_mnote_data_get_id          (ExifMnoteData *d, unsigned int n);
  * containing only US-ASCII alphanumeric characters.
  *
  * \param[in] d MakerNote data
- * \param[in] n tag number within the namespace of this type of MakerNote
+ * \param[in] n index of the entry within the MakerNote data
  * \return textual name of the tag
  */
 const char  *exif_mnote_data_get_name        (ExifMnoteData *d, unsigned int n);
 
 /*! Returns textual title of the given MakerNote tag.
+ * The title is a short, localized textual description of the tag.
  *
  * \param[in] d MakerNote data
- * \param[in] n tag number within the namespace of this type of MakerNote
+ * \param[in] n index of the entry within the MakerNote data
  * \return textual name of the tag
  */
 const char  *exif_mnote_data_get_title       (ExifMnoteData *d, unsigned int n);
@@ -93,7 +94,7 @@ const char  *exif_mnote_data_get_title       (ExifMnoteData *d, unsigned int n);
 /*! Returns verbose textual description of the given MakerNote tag.
  *
  * \param[in] d MakerNote data
- * \param[in] n tag number within the namespace of this type of MakerNote
+ * \param[in] n index of the entry within the MakerNote data
  * \return textual description of the tag
  */
 const char  *exif_mnote_data_get_description (ExifMnoteData *d, unsigned int n);
@@ -105,7 +106,7 @@ const char  *exif_mnote_data_get_description (ExifMnoteData *d, unsigned int n);
  *          of the camera.
  *
  * \param[in] d MakerNote data
- * \param[in] n tag number within the namespace of this type of MakerNote
+ * \param[in] n index of the entry within the MakerNote data
  * \param[out] val buffer in which to store value
  * \param[in] maxlen length of the buffer val
  * \return val pointer, or NULL on error