From 8d838e89eeecc34ad54547ebf198ff5d40ec29dc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= <flashcode@flashtux.org>
Date: Thu, 18 May 2023 11:07:46 +0200
Subject: [PATCH] alias: add example in comment of function alias_replace_args

---
 src/plugins/alias/alias.c | 8 ++++++++
 1 file changed, 8 insertions(+)

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.
  */