[eog] Add API documentation comments to EogExifUtils
- From: Felix Riemann <friemann src gnome org>
- To: svn-commits-list gnome org
- Subject: [eog] Add API documentation comments to EogExifUtils
- Date: Fri, 22 May 2009 15:34:29 -0400 (EDT)
commit 40c7f67f13ae4b994de266f268eb1aefeafd8895
Author: Felix Riemann <friemann svn gnome org>
Date: Fri May 22 20:36:31 2009 +0200
Add API documentation comments to EogExifUtils
---
ChangeLog | 4 ++++
src/eog-exif-util.c | 24 ++++++++++++++++++++++++
2 files changed, 28 insertions(+), 0 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index d427277..4bdc2fb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2009-05-22 Felix Riemann <friemann svn gnome org>
+ * src/eog-exif-util.c: Add API docs.
+
+2009-05-22 Felix Riemann <friemann svn gnome org>
+
* bindings/python/eog.defs:
* src/eog-job-queue.c (handle_job):
* src/eog-jobs.c (eog_job_run_default), (eog_job_class_init),
diff --git a/src/eog-exif-util.c b/src/eog-exif-util.c
index cb76544..d8cf772 100644
--- a/src/eog-exif-util.c
+++ b/src/eog-exif-util.c
@@ -162,6 +162,16 @@ eog_exif_util_format_date_by_hand (const gchar *date)
}
#endif /* HAVE_STRPTIME */
+/**
+ * eog_exif_util_format_date:
+ * @date: a date string following Exif specifications
+ *
+ * Takes a date string formatted after Exif specifications and generates a
+ * more readable, possibly localized, string out of it.
+ *
+ * Returns: a newly allocated date string formatted according to the
+ * current locale.
+ */
gchar *
eog_exif_util_format_date (const gchar *date)
{
@@ -174,6 +184,20 @@ eog_exif_util_format_date (const gchar *date)
return new_date;
}
+/**
+ * eog_exif_util_get_value:
+ * @exif_data: pointer to an <structname>ExifData</structname> struct
+ * @tag_id: the requested tag's id. See <filename>exif-tag.h</filename>
+ * from the libexif package for possible values (e.g. %EXIF_TAG_EXPOSURE_MODE).
+ * @buffer: a pre-allocated output buffer
+ * @buf_size: size of @buffer
+ *
+ * Convenience function to extract a string representation of an Exif tag
+ * directly from an <structname>ExifData</structname> struct. The string is
+ * written into @buffer as far as @buf_size permits.
+ *
+ * Returns: a pointer to @buffer.
+ */
const gchar *
eog_exif_util_get_value (ExifData *exif_data, gint tag_id, gchar *buffer, guint buf_size)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]