[libgepub/wip/cosimoc/fixes: 8/8] build: fix introspection warnings



commit 998423f481a14f9f8385865864fc9a5a9f529980
Author: Cosimo Cecchi <cosimoc gnome org>
Date:   Sun Jun 12 15:35:16 2016 -0700

    build: fix introspection warnings

 libgepub/gepub-archive.c    |    6 ++++++
 libgepub/gepub-doc.c        |    5 ++---
 libgepub/gepub-doc.h        |   10 ----------
 libgepub/gepub-text-chunk.h |    2 +-
 libgepub/gepub-utils.c      |   30 +++++++++++++++++++++++++-----
 5 files changed, 34 insertions(+), 19 deletions(-)
---
diff --git a/libgepub/gepub-archive.c b/libgepub/gepub-archive.c
index 5805b32..20c9e80 100644
--- a/libgepub/gepub-archive.c
+++ b/libgepub/gepub-archive.c
@@ -105,6 +105,12 @@ gepub_archive_new (const gchar *path)
     return archive;
 }
 
+/**
+ * gepub_archive_list_files:
+ * @archive: a #GepubArchive
+ *
+ * Returns: (element-type utf8) (transfer full): list of files in the archive
+ */
 GList *
 gepub_archive_list_files (GepubArchive *archive)
 {
diff --git a/libgepub/gepub-doc.c b/libgepub/gepub-doc.c
index 1a96fe1..cf5c8c3 100644
--- a/libgepub/gepub-doc.c
+++ b/libgepub/gepub-doc.c
@@ -200,7 +200,6 @@ gepub_doc_initable_iface_init (GInitableIface *iface)
 /**
  * gepub_doc_new:
  * @path: the epub doc path
- * @error: location to store a #GError, or %NULL
  *
  * Returns: (transfer full): the new GepubDoc created
  */
@@ -552,7 +551,7 @@ gepub_doc_get_text_by_id (GepubDoc *doc, gchar *id)
 
 /**
  * gepub_doc_free_text:
- * @doc: a #GList
+ * @tlist: (element-type Gepub.TextChunk): a #GList
  */
 void
 gepub_doc_free_text (GList *tlist)
@@ -575,7 +574,7 @@ gboolean gepub_doc_go_next (GepubDoc *doc)
 }
 
 /**
- * gepub_doc_go_next:
+ * gepub_doc_go_prev:
  * @doc: a #GepubDoc
  * Returns: TRUE on success, FALSE if there's no prev pages
  */
diff --git a/libgepub/gepub-doc.h b/libgepub/gepub-doc.h
index 9de28fa..a0e22ab 100644
--- a/libgepub/gepub-doc.h
+++ b/libgepub/gepub-doc.h
@@ -70,40 +70,30 @@ G_END_DECLS
 /**
  * GEPUB_META_TITLE:
  * The book title.
- *
- * Value: title
  */
 #define GEPUB_META_TITLE "title"
 
 /**
  * GEPUB_META_LANG:
  * The book lang.
- *
- * Value: language
  */
 #define GEPUB_META_LANG "language"
 
 /**
  * GEPUB_META_ID:
  * The book id.
- *
- * Value: identifier
  */
 #define GEPUB_META_ID "identifier"
 
 /**
  * GEPUB_META_AUTHOR:
  * The book author.
- *
- * Value: creator
  */
 #define GEPUB_META_AUTHOR "creator"
 
 /**
  * GEPUB_META_DESC:
  * The book description.
- *
- * Value: description
  */
 #define GEPUB_META_DESC "description"
 
diff --git a/libgepub/gepub-text-chunk.h b/libgepub/gepub-text-chunk.h
index ea9bc4f..7c53f15 100644
--- a/libgepub/gepub-text-chunk.h
+++ b/libgepub/gepub-text-chunk.h
@@ -54,7 +54,7 @@ typedef struct _GepubTextChunk      GepubTextChunk;
 typedef struct _GepubTextChunkClass GepubTextChunkClass;
 
 GType               gepub_text_chunk_get_type     (void) G_GNUC_CONST;
-GepubTextChunk     *gepub_text_chunk_new          (GepubTextChunkType type, const guchar *path);
+GepubTextChunk     *gepub_text_chunk_new          (GepubTextChunkType type, const guchar *text);
 gchar              *gepub_text_chunk_type_str     (GepubTextChunk *chunk);
 gchar              *gepub_text_chunk_text         (GepubTextChunk *chunk);
 GepubTextChunkType  gepub_text_chunk_type         (GepubTextChunk *chunk);
diff --git a/libgepub/gepub-utils.c b/libgepub/gepub-utils.c
index 23f2309..a0c23b6 100644
--- a/libgepub/gepub-utils.c
+++ b/libgepub/gepub-utils.c
@@ -27,8 +27,7 @@
 #include "gepub-text-chunk.h"
 
 
-/**
- * Replaces the attr value with epub:// prefix for the tagname. This
+/* Replaces the attr value with epub:// prefix for the tagname. This
  * function also makes the resource absolute based on the epub root
  */
 static void
@@ -101,6 +100,13 @@ gepub_utils_has_parent_tag (xmlNode *node, gchar *name, ...)
     return FALSE;
 }
 
+/**
+ * gepub_utils_get_element_by_tag: (skip):
+ * @node: an #xmlNode
+ * @name: the tag name
+ *
+ * Returns: the tag matching @name.
+ */
 xmlNode *
 gepub_utils_get_element_by_tag (xmlNode *node, gchar *name)
 {
@@ -120,6 +126,14 @@ gepub_utils_get_element_by_tag (xmlNode *node, gchar *name)
     return ret;
 }
 
+/**
+ * gepub_utils_get_element_by_attr: (skip):
+ * @node: an #xmlNode
+ * @attr: the attribute
+ * @value: the value
+ *
+ * Returns: the element matching @attr and @value.
+ */
 xmlNode *
 gepub_utils_get_element_by_attr (xmlNode *node, gchar *attr, gchar *value)
 {
@@ -148,6 +162,13 @@ gepub_utils_get_element_by_attr (xmlNode *node, gchar *attr, gchar *value)
     return ret;
 }
 
+/**
+ * gepub_utils_get_text_elements:
+ * @node: an #xmlNode
+ *
+ * Returns: (element-type Gepub.TextChunk) (transfer full): the text elements
+ *  of @node.
+ */
 GList *
 gepub_utils_get_text_elements (xmlNode *node)
 {
@@ -196,10 +217,9 @@ gepub_utils_get_text_elements (xmlNode *node)
     return text_list;
 }
 
-/**
- * replacing epub media paths, for css, image and svg files, to be
+/* Replacing epub media paths, for css, image and svg files, to be
  * able to provide these files to webkit from the epub file
- **/
+ */
 guchar *
 gepub_utils_replace_resources (guchar *content, gsize *bufsize, gchar *path)
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]