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.
This commit is contained in:
Thomas Martitz 2017-03-30 08:02:29 +02:00
parent 7fdd360b85
commit fb9673eb61
2 changed files with 2 additions and 2 deletions

View File

@ -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).

View File

@ -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.