summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2023-05-18 11:07:46 +0200
committerSébastien Helleu <flashcode@flashtux.org>2023-05-18 11:07:46 +0200
commit8d838e89eeecc34ad54547ebf198ff5d40ec29dc (patch)
tree1efb77ea0ecc363a886ad4694746089d7db7355a
parente237f7488f1133df286570c4090ecab91d53d421 (diff)
downloadweechat-8d838e89eeecc34ad54547ebf198ff5d40ec29dc.zip
alias: add example in comment of function alias_replace_args
-rw-r--r--src/plugins/alias/alias.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/plugins/alias/alias.c b/src/plugins/alias/alias.c
index f077a17d8..4971e3c6f 100644
--- a/src/plugins/alias/alias.c
+++ b/src/plugins/alias/alias.c
@@ -209,6 +209,14 @@ alias_string_add_arguments (char **alias, int *length, char **argv, int start,
* $& all arguments, with double quotes escaped (" replaced by \")
* $~ last argument
*
+ * Example:
+ *
+ * Parameters:
+ * alias_args = "$2 $1 '$3-'"
+ * user_args = "abc def ghi jkl"
+ *
+ * Result = "def abc 'ghi jkl'"
+ *
* Note: result must be freed after use.
*/