[anjuta] libanjuta: bgo #696984 - Add some missing documentation comment



commit c1c4f2563ef0cc588a0301ddbeac70951516cedd
Author: Arnel A. Borja <kyoushuu yahoo com>
Date:   Fri Mar 29 15:40:59 2013 +0800

    libanjuta: bgo #696984 - Add some missing documentation comment

 libanjuta/anjuta-pkg-scanner.c  |   19 +++++++++++++++++++
 libanjuta/anjuta-token-stream.c |    1 +
 libanjuta/anjuta-utils.c        |    9 +++++++++
 3 files changed, 29 insertions(+), 0 deletions(-)
---
diff --git a/libanjuta/anjuta-pkg-scanner.c b/libanjuta/anjuta-pkg-scanner.c
index 189b4f0..e26ebfd 100644
--- a/libanjuta/anjuta-pkg-scanner.c
+++ b/libanjuta/anjuta-pkg-scanner.c
@@ -223,17 +223,36 @@ anjuta_pkg_scanner_new (const gchar* package, const gchar* version)
        return ANJUTA_COMMAND (object);
 }
 
+/*
+ * anjuta_pkg_scanner_get_files:
+ * @scanner: PkgScanner object
+ *
+ * Returns: Name of the package to scan.
+ */
 const gchar* 
 anjuta_pkg_scanner_get_package (AnjutaPkgScanner* scanner)
 {
        return scanner->priv->package;
 }
+
+/*
+ * anjuta_pkg_scanner_get_files:
+ * @scanner: PkgScanner object
+ *
+ * Returns: Version of the package to scan.
+ */
 const gchar* 
 anjuta_pkg_scanner_get_version (AnjutaPkgScanner* scanner)
 {
        return scanner->priv->version;
 }
 
+/*
+ * anjuta_pkg_scanner_get_files:
+ * @scanner: PkgScanner object
+ *
+ * Returns: (element-type GFile*): List of files to scan.
+ */
 GList*
 anjuta_pkg_scanner_get_files (AnjutaPkgScanner* scanner)
 {
diff --git a/libanjuta/anjuta-token-stream.c b/libanjuta/anjuta-token-stream.c
index c03577c..8131ccc 100644
--- a/libanjuta/anjuta-token-stream.c
+++ b/libanjuta/anjuta-token-stream.c
@@ -310,6 +310,7 @@ anjuta_token_stream_get_current_file (AnjutaTokenStream *stream)
  * @parent: a parent #AnjutaTokenStream object or NULL.
  * @root: a token or NULL
  * @content: a token list.
+ * @file: (allow-none): a #GFile of the file.
  *
  * Create a new stream from a list of tokens. If a parent stream is passed,
  * the new stream keep a link on it, so we can return it when the new stream
diff --git a/libanjuta/anjuta-utils.c b/libanjuta/anjuta-utils.c
index 3632e62..694fce4 100644
--- a/libanjuta/anjuta-utils.c
+++ b/libanjuta/anjuta-utils.c
@@ -1336,6 +1336,15 @@ anjuta_util_jump_to_matching_brace (IAnjutaIterable *iter, gchar brace, gint lim
        return FALSE;
 }
 
+/**
+ * anjuta_util_parse_args_from_string:
+ * @string: arguments
+ *
+ * Parse arguments from a string to a GList.
+ *
+ * Returns: (element-type utf8) (transfer full): A newly allocated GList of
+ * strings.
+ */
 GList*
 anjuta_util_parse_args_from_string (const gchar* string)
 {


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