[geany/geany] fb9673: api: pass gtkdoc annotation parameter as-is

Thomas Martitz git-noreply at xxxxx
Mon Dec 3 21:33:59 UTC 2018


Branch:      refs/heads/master
Author:      Thomas Martitz <kugel at rockbox.org>
Committer:   Thomas Martitz <kugel at rockbox.org>
Date:        Mon, 03 Dec 2018 21:33:59 UTC
Commit:      fb9673eb61c44baba6a94f7ad3ef429ffa021c73
             https://github.com/geany/geany/commit/fb9673eb61c44baba6a94f7ad3ef429ffa021c73

Log Message:
-----------
api: pass gtkdoc annotation parameter as-is

The array annotation has many possible parameters, this avoids having a Doxygen
command for each one.

Luckily you can define Doxygen commands multiple times with different a number
of parameters each.


Modified Paths:
--------------
    doc/Doxyfile.in
    src/utils.c

Modified: doc/Doxyfile.in
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -263,7 +263,7 @@ ALIASES               += "cb=\noop \xmlonly <simplesect kind=\"geany:scope\">not
 ALIASES               += "cbdata=\noop \xmlonly <simplesect kind=\"geany:closure\"></simplesect>\endxmlonly"
 ALIASES               += "cbfree=\noop \xmlonly <simplesect kind=\"geany:destroy\"></simplesect>\endxmlonly"
 ALIASES               += "array=\noop \xmlonly <simplesect kind=\"geany:array\"></simplesect>\endxmlonly"
-ALIASES               += "arraylen{1}=\noop \xmlonly <simplesect kind=\"geany:array\">length=\1</simplesect>\endxmlonly"
+ALIASES               += "array{1}=\noop \xmlonly <simplesect kind=\"geany:array\">\1</simplesect>\endxmlonly"
 
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).


Modified: src/utils.c
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -2155,7 +2155,7 @@ gchar *utils_strv_find_lcs(gchar **strv, size_t num)
  * The algorthm strips the common prefix (e-g. the user's home directory) and
  * replaces the longest common substring with an ellipsis ("...").
  *
- * @param file_names @arraylen{num} The list of strings to process.
+ * @param file_names @array{length=num} The list of strings to process.
  * @param num The number of strings contained in @a file_names. Can be 0 if it's terminated by @c NULL.
  * @return @transfer{full} A newly-allocated array of transformed paths strings, terminated by
             @c NULL. Use @c g_strfreev() to free it.



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).


More information about the Commits mailing list