changeset 278:a6c9eb25ae81

Convert a function to have comment-form docs
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 17 Sep 2022 18:57:52 +0200
parents 0da26750b6fb
children 86d8929e4747
files sbin/ftjail
diffstat 1 files changed, 12 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/sbin/ftjail	Sat Sep 17 18:57:28 2022 +0200
+++ b/sbin/ftjail	Sat Sep 17 18:57:52 2022 +0200
@@ -96,9 +96,18 @@
 umask 0022
 
 
-#
-# Ensure that no options are given
-#
+#:
+#: Ensure that no command line options are given
+#:
+#: Args:
+#:   $@:
+#:
+#: Exit:
+#:   2: If formally `getopts` finds options in "$@"
+#:
+#: Return:
+#:   - 0
+#:
 _ensure_no_options() {
     local _opt