Add docstrings

libexec/saturnin-clip

@@ -5,6 +5,9 @@
 ffoo import config
 ffoo import pretty
 
+#
+# Where to store clips
+#
 STORAGE_DIR="$SATURNIN_CACHE_HOME/clips"
 
 usage() {
@@ -33,6 +36,9 @@ clipln() {
 }
 
 save_clip() {
+    #
+    # Save single clip
+    #
     local clipname=$1
     mkdir -p "$STORAGE_DIR" || die "could not create directory for saving"
     local path="$STORAGE_DIR/$(date +%Y%m%d-%H%M%S.clip)"
@@ -40,6 +46,9 @@ save_clip() {
 }
 
 lsclips() {
+    #
+    # List clips with MIME types and hints
+    #
     local clipname=$1
     local ft hint name
     test -d "$STORAGE_DIR" || return 0
@@ -60,18 +69,27 @@ lsclips() {
 }
 
 load_clip() {
+    #
+    # Load single clip of choice
+    #
     local clipname=$1
     local name=$(saturnin clip ls | saturnin dmenu | cut -d\   -f 1)
     cat $STORAGE_DIR/$name | xclip -i -selection $clipname
 }
 
 rm_clip() {
+    #
+    # Remove single clip of choice
+    #
     local clipname=$1
     local name=$(saturnin clip ls | saturnin dmenu | cut -d\   -f 1)
     rm -f $STORAGE_DIR/$name
 }
 
 rm_all() {
+    #
+    # Dump all clips
+    #
     test -n "$STORAGE_DIR" || die "storage directory is unset, aborting"
     test -d "$STORAGE_DIR" || return 0
     find "$STORAGE_DIR" -name "*.clip" | xargs rm -f