[gimp] libgimpconfig: update some description comments.



commit bc427479e055ae42f765d368ae81181f97d2fb83
Author: Jehan <jehan girinstud io>
Date:   Tue Jul 17 12:32:05 2018 +0200

    libgimpconfig: update some description comments.
    
    Second parameter of gimp_scanner_parse_token() and
    gimp_scanner_parse_identifier() is not a return value. It is a value to
    compare with.

 libgimpconfig/gimpscanner.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
---
diff --git a/libgimpconfig/gimpscanner.c b/libgimpconfig/gimpscanner.c
index b8b2f9108e..b23ce357d9 100644
--- a/libgimpconfig/gimpscanner.c
+++ b/libgimpconfig/gimpscanner.c
@@ -339,9 +339,9 @@ gimp_scanner_destroy (GScanner *scanner)
  * gimp_scanner_parse_token:
  * @scanner: A #GScanner created by gimp_scanner_new_file() or
  *           gimp_scanner_new_string()
- * @token: Return location for the parsed token
+ * @token: the #GTokenType expected as next token.
  *
- * Return value: %TRUE on success
+ * Return value: %TRUE if the next token is @token, %FALSE otherwise.
  *
  * Since: 2.4
  **/
@@ -361,9 +361,10 @@ gimp_scanner_parse_token (GScanner   *scanner,
  * gimp_scanner_parse_identifier:
  * @scanner: A #GScanner created by gimp_scanner_new_file() or
  *           gimp_scanner_new_string()
- * @identifier: Return location for the parsed identifier
+ * @identifier: the expected identifier.
  *
- * Return value: %TRUE on success
+ * Return value: %TRUE if the next token is an identifier and if its
+ * value matches @identifier.
  *
  * Since: 2.4
  **/


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