[gexiv2] doc: More fixes and cleanups
- From: Jens Georg <jensgeorg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gexiv2] doc: More fixes and cleanups
- Date: Sat, 1 Oct 2016 09:59:37 +0000 (UTC)
commit 7e3a39627d7b597564726d15aaae2844ae9eb11a
Author: Jens Georg <mail jensge org>
Date: Sun Jul 17 19:54:11 2016 +0200
doc: More fixes and cleanups
docs/reference/Makefile.am | 6 +-
docs/reference/gexiv2-docs.xml | 21 ++++-----
gexiv2/gexiv2-log-private.h | 2 +-
gexiv2/gexiv2-metadata-private.h | 72 ++++++++++++++--------------
gexiv2/gexiv2-metadata.h | 10 ++--
gexiv2/gexiv2-preview-image-private.h | 2 +-
gexiv2/gexiv2-preview-properties-private.h | 4 +-
7 files changed, 57 insertions(+), 60 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 38fee4d..a149c8c 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -39,8 +39,8 @@ FIXXREF_OPTIONS=
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=
-CFILE_GLOB=
+HFILE_GLOB=$(top_srcdir)/gexiv2/*.h
+CFILE_GLOB=$(top_srcdir)/gexiv2/*.cpp
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
@@ -48,7 +48,7 @@ EXTRA_HFILES=
# Header files or dirs to ignore when scanning. Use base file/dir names
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
-IGNORE_HFILES=
+IGNORE_HFILES=*-private.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/docs/reference/gexiv2-docs.xml b/docs/reference/gexiv2-docs.xml
index 9074616..7136cb6 100644
--- a/docs/reference/gexiv2-docs.xml
+++ b/docs/reference/gexiv2-docs.xml
@@ -17,18 +17,15 @@
</bookinfo>
<chapter>
- <title>[Insert title here]</title>
- <xi:include href="xml/gexiv2-log.xml"/>
- <xi:include href="xml/gexiv2-log-private.xml"/>
- <xi:include href="xml/gexiv2-managed-stream.xml"/>
- <xi:include href="xml/gexiv2-metadata.xml"/>
- <xi:include href="xml/gexiv2-metadata-private.xml"/>
- <xi:include href="xml/gexiv2-preview-image.xml"/>
- <xi:include href="xml/gexiv2-preview-image-private.xml"/>
- <xi:include href="xml/gexiv2-preview-properties.xml"/>
- <xi:include href="xml/gexiv2-preview-properties-private.xml"/>
- <xi:include href="xml/gexiv2-startup.xml"/>
- <xi:include href="xml/gexiv2-version.xml"/>
+ <title>[Insert title here]</title>
+ <xi:include href="xml/gexiv2-log.xml"/>
+ <xi:include href="xml/gexiv2-log-private.xml"/>
+ <xi:include href="xml/gexiv2-managed-stream.xml"/>
+ <xi:include href="xml/gexiv2-metadata.xml"/>
+ <xi:include href="xml/gexiv2-preview-image.xml"/>
+ <xi:include href="xml/gexiv2-preview-properties.xml"/>
+ <xi:include href="xml/gexiv2-startup.xml"/>
+ <xi:include href="xml/gexiv2-version.xml"/>
</chapter>
<chapter id="object-tree">
diff --git a/gexiv2/gexiv2-log-private.h b/gexiv2/gexiv2-log-private.h
index 38b77c8..394a479 100644
--- a/gexiv2/gexiv2-log-private.h
+++ b/gexiv2/gexiv2-log-private.h
@@ -15,7 +15,7 @@
G_BEGIN_DECLS
-gboolean gexiv2_log_is_handler_installed(void);
+G_GNUC_INTERNAL gboolean gexiv2_log_is_handler_installed(void);
G_END_DECLS
diff --git a/gexiv2/gexiv2-metadata-private.h b/gexiv2/gexiv2-metadata-private.h
index 16d38ef..5e8da22 100644
--- a/gexiv2/gexiv2-metadata-private.h
+++ b/gexiv2/gexiv2-metadata-private.h
@@ -38,53 +38,53 @@ struct _GExiv2MetadataPrivate
/* private EXIF functions */
-gboolean gexiv2_metadata_has_exif_tag (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_clear_exif_tag (GExiv2Metadata *self, const gchar* tag);
-gchar* gexiv2_metadata_get_exif_tag_string (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_set_exif_tag_string (GExiv2Metadata *self, const gchar* tag,
const gchar* value);
-gchar* gexiv2_metadata_get_exif_tag_interpreted_string (GExiv2Metadata *self, const gchar*
tag);
-glong gexiv2_metadata_get_exif_tag_long (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_set_exif_tag_long (GExiv2Metadata *self, const gchar* tag,
glong value);
-gdouble gexiv2_metadata_get_exif_tag_rational_as_double (GExiv2Metadata *self, const
gchar* tag, gdouble def);
-const gchar* gexiv2_metadata_get_exif_tag_label (const gchar* tag);
-const gchar* gexiv2_metadata_get_exif_tag_description (const gchar* tag);
-const gchar* gexiv2_metadata_get_exif_tag_type (const gchar* tag);
-
+G_GNUC_INTERNAL gboolean gexiv2_metadata_has_exif_tag (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_clear_exif_tag (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gchar* gexiv2_metadata_get_exif_tag_string (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_exif_tag_string (GExiv2Metadata *self, const
gchar* tag, const gchar* value);
+G_GNUC_INTERNAL gchar* gexiv2_metadata_get_exif_tag_interpreted_string (GExiv2Metadata
*self, const gchar* tag);
+G_GNUC_INTERNAL glong gexiv2_metadata_get_exif_tag_long (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_exif_tag_long (GExiv2Metadata *self, const
gchar* tag, glong value);
+G_GNUC_INTERNAL gdouble gexiv2_metadata_get_exif_tag_rational_as_double
(GExiv2Metadata *self, const gchar* tag, gdouble def);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_exif_tag_label (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_exif_tag_description (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_exif_tag_type (const gchar* tag);
+G_GNUC_INTERNAL
GBytes* gexiv2_metadata_get_exif_tag_raw (GExiv2Metadata *self, const gchar*
tag);
/* private XMP functions */
-gboolean gexiv2_metadata_clear_xmp_tag (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_has_xmp_tag (GExiv2Metadata *self, const gchar*
tag);
-gchar* gexiv2_metadata_get_xmp_tag_string (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_set_xmp_tag_string (GExiv2Metadata *self, const gchar* tag,
const gchar* value);
-gchar* gexiv2_metadata_get_xmp_tag_interpreted_string (GExiv2Metadata *self, const gchar*
tag);
-glong gexiv2_metadata_get_xmp_tag_long (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_set_xmp_tag_long (GExiv2Metadata *self, const gchar* tag,
glong value);
-gchar** gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_set_xmp_tag_multiple (GExiv2Metadata *self, const gchar* tag, const
gchar** values);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_clear_xmp_tag (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_has_xmp_tag (GExiv2Metadata
*self, const gchar* tag);
+G_GNUC_INTERNAL gchar* gexiv2_metadata_get_xmp_tag_string (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_xmp_tag_string (GExiv2Metadata *self, const
gchar* tag, const gchar* value);
+G_GNUC_INTERNAL gchar* gexiv2_metadata_get_xmp_tag_interpreted_string (GExiv2Metadata *self,
const gchar* tag);
+G_GNUC_INTERNAL glong gexiv2_metadata_get_xmp_tag_long (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_xmp_tag_long (GExiv2Metadata *self, const
gchar* tag, glong value);
+G_GNUC_INTERNAL gchar** gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self,
const gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_xmp_tag_multiple (GExiv2Metadata *self, const
gchar* tag, const gchar** values);
-const gchar* gexiv2_metadata_get_xmp_tag_label (const gchar* tag);
-const gchar* gexiv2_metadata_get_xmp_tag_description (const gchar* tag);
-const gchar* gexiv2_metadata_get_xmp_tag_type (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_xmp_tag_label (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_xmp_tag_description (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_xmp_tag_type (const gchar* tag);
-GBytes* gexiv2_metadata_get_xmp_tag_raw (GExiv2Metadata *self, const gchar*
tag);
+G_GNUC_INTERNAL GBytes* gexiv2_metadata_get_xmp_tag_raw (GExiv2Metadata
*self, const gchar* tag);
/* private IPTC functions */
-gboolean gexiv2_metadata_clear_iptc_tag (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_has_iptc_tag (GExiv2Metadata *self, const gchar* tag);
-gchar* gexiv2_metadata_get_iptc_tag_string (GExiv2Metadata *self, const gchar* tag);
-gboolean gexiv2_metadata_set_iptc_tag_string (GExiv2Metadata *self, const gchar* tag,
const gchar* value);
-gchar* gexiv2_metadata_get_iptc_tag_interpreted_string (GExiv2Metadata *self, const gchar*
tag);
-gchar** gexiv2_metadata_get_iptc_tag_multiple (GExiv2Metadata *self, const gchar*
tag);
-gboolean gexiv2_metadata_set_iptc_tag_multiple (GExiv2Metadata *self, const gchar* tag,
const gchar** values);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_clear_iptc_tag (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_has_iptc_tag (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gchar* gexiv2_metadata_get_iptc_tag_string (GExiv2Metadata *self, const
gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_iptc_tag_string (GExiv2Metadata *self, const
gchar* tag, const gchar* value);
+G_GNUC_INTERNAL gchar* gexiv2_metadata_get_iptc_tag_interpreted_string (GExiv2Metadata
*self, const gchar* tag);
+G_GNUC_INTERNAL gchar** gexiv2_metadata_get_iptc_tag_multiple (GExiv2Metadata
*self, const gchar* tag);
+G_GNUC_INTERNAL gboolean gexiv2_metadata_set_iptc_tag_multiple (GExiv2Metadata *self, const
gchar* tag, const gchar** values);
-const gchar* gexiv2_metadata_get_iptc_tag_label (const gchar* tag);
-const gchar* gexiv2_metadata_get_iptc_tag_description (const gchar* tag);
-const gchar* gexiv2_metadata_get_iptc_tag_type (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_iptc_tag_label (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_iptc_tag_description (const gchar* tag);
+G_GNUC_INTERNAL const gchar* gexiv2_metadata_get_iptc_tag_type (const gchar* tag);
-GBytes* gexiv2_metadata_get_iptc_tag_raw (GExiv2Metadata *self, const gchar*
tag);
+G_GNUC_INTERNAL GBytes* gexiv2_metadata_get_iptc_tag_raw (GExiv2Metadata
*self, const gchar* tag);
G_END_DECLS
diff --git a/gexiv2/gexiv2-metadata.h b/gexiv2/gexiv2-metadata.h
index f457483..bea2579 100644
--- a/gexiv2/gexiv2-metadata.h
+++ b/gexiv2/gexiv2-metadata.h
@@ -93,17 +93,13 @@ typedef enum {
GEXIV2_OMIT_ALL_FORMATTING = 0x0800UL //!< Omit all formatting whitespace.
} GExiv2XmpFormatFlags;
-typedef struct _GExiv2Metadata GExiv2Metadata;
-typedef struct _GExiv2MetadataClass GExiv2MetadataClass;
-typedef struct _GExiv2MetadataPrivate GExiv2MetadataPrivate;
-
/**
* GExiv2Metadata:
*
* An object holding all the Exiv2 metadata. Previews, if present, are also available.
*
* As gexiv2 is only a wrapper around Exiv2, it's better to read its documentaiton to understand
- * the full scope of what it offers: http://www.exiv2.org/
+ * the full scope of what it offers: [http://www.exiv2.org/]
*
* In particular, rather than providing a getter/setter method pair for every metadata value
* available for images (of which there are thousands), Exiv2 uses a dotted addressing scheme.
@@ -113,6 +109,10 @@ typedef struct _GExiv2MetadataPrivate GExiv2MetadataPrivate;
*
* A full reference for all supported Exiv2 tags can be found at http://www.exiv2.org/metadata.html
*/
+typedef struct _GExiv2Metadata GExiv2Metadata;
+typedef struct _GExiv2MetadataClass GExiv2MetadataClass;
+typedef struct _GExiv2MetadataPrivate GExiv2MetadataPrivate;
+
struct _GExiv2Metadata
{
GObject parent_instance;
diff --git a/gexiv2/gexiv2-preview-image-private.h b/gexiv2/gexiv2-preview-image-private.h
index e1239a2..921fa76 100644
--- a/gexiv2/gexiv2-preview-image-private.h
+++ b/gexiv2/gexiv2-preview-image-private.h
@@ -22,7 +22,7 @@ struct _GExiv2PreviewImagePrivate
gchar *extension;
};
-GExiv2PreviewImage* gexiv2_preview_image_new (Exiv2::PreviewManager *manager,
+G_GNUC_INTERNAL GExiv2PreviewImage* gexiv2_preview_image_new (Exiv2::PreviewManager *manager,
const Exiv2::PreviewProperties &props);
G_END_DECLS
diff --git a/gexiv2/gexiv2-preview-properties-private.h b/gexiv2/gexiv2-preview-properties-private.h
index 40c0c81..0baa707 100644
--- a/gexiv2/gexiv2-preview-properties-private.h
+++ b/gexiv2/gexiv2-preview-properties-private.h
@@ -21,8 +21,8 @@ struct _GExiv2PreviewPropertiesPrivate
};
-GExiv2PreviewProperties* gexiv2_preview_properties_new (Exiv2::PreviewProperties &props);
-void gexiv2_preview_properties_free(GExiv2PreviewProperties *self);
+G_GNUC_INTERNAL GExiv2PreviewProperties* gexiv2_preview_properties_new (Exiv2::PreviewProperties &props);
+G_GNUC_INTERNAL void gexiv2_preview_properties_free(GExiv2PreviewProperties *self);
G_END_DECLS
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
