Created SILC Runtime Toolkit git repository Part II.

[runtime.git] / lib / silcutil / silcregex.h

diff --git a/lib/silcutil/silcregex.h b/lib/silcutil/silcregex.h
index 4047088f8a6767ac10899b2ed6c7f4522c1b8aae..8b5a66544f26fd3893bb2c3717110eabae1c6d94 100644 (file)
--- a/lib/silcutil/silcregex.h
+++ b/lib/silcutil/silcregex.h
@@ -370,6 +370,11 @@ SilcBool silc_regex_buffer(SilcBuffer buffer, const char *regex,
  *    using the SILC_STR_REGEX in SILC Buffer Format API directly.  This
  *    function only provides basic matching and substitution.
  *
+ * EXAMPLE
+ *
+ *    // Replace all foos with bar on all lines in the buffer
+ *    silc_subst(buffer, "s/foo/bar/g");
+ *
  ***/
 SilcBool silc_subst(SilcBuffer buffer, const char *subst);