subcommand: Add documentation of gsu_complete_options().

It's a public function that should be documented.

diff --git a/subcommand b/subcommand
index 60d8402062ffcbc84eb81f0aa497a98e89f68120..1e04d16c8f047b59105e5bf614070295f73fb0da 100644 (file)
--- a/subcommand
+++ b/subcommand
@@ -68,6 +68,8 @@ _gsu_print_available_commands()
        printf '\n'
 }
 
+# Print all options of the given optstring to stdout if the word in the current
+# command line begins with a hyphen character.
 gsu_complete_options()
 {
        local opts="$1" cword="$2" cur opt