[libgepub] lib: Fix API docs



commit 2cacec1eafb8d49d0ce4bc22cf2b82faa989587f
Author: Bastien Nocera <hadess hadess net>
Date:   Thu Jun 22 10:32:25 2017 +0200

    lib: Fix API docs
    
    Fixing the GIR scanner's errors.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=784081

 libgepub/gepub-utils.c |   18 ++++++++++++++----
 1 files changed, 14 insertions(+), 4 deletions(-)
---
diff --git a/libgepub/gepub-utils.c b/libgepub/gepub-utils.c
index f6c9a25..0a6e47e 100644
--- a/libgepub/gepub-utils.c
+++ b/libgepub/gepub-utils.c
@@ -228,8 +228,15 @@ gepub_utils_get_text_elements (xmlNode *node)
     return text_list;
 }
 
-/* Replacing epub media paths, for css, image and svg files, to be
- * able to provide these files to webkit from the epub file
+/**
+ * gepub_utils_replace_resources:
+ * @content: a #GBytes containing the XML data
+ * @path: The path to replace
+ *
+ * Replacing epub media paths, for css, image and svg files, to be
+ * able to provide these files to webkit from the epub file.
+ *
+ * Returns: a new #GBytes containing the updated XML data
  */
 GBytes *
 gepub_utils_replace_resources (GBytes *content, const gchar *path)
@@ -261,8 +268,11 @@ gepub_utils_replace_resources (GBytes *content, const gchar *path)
 
 
 /**
- * Returns a gchar* with the property with the name prop in the xmlNode
- * node
+ * gepub_utils_get_prop:
+ * @node: an #xmlNode
+ * @prop: a property
+ *
+ * Returns: a string with the property contained in @prop
  */
 gchar *
 gepub_utils_get_prop (xmlNode *node, const gchar *prop)


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