Apply function docstring style

99bottles.sh

@@ -22,7 +22,10 @@ breakLine=$([ "$1" = --careless ] \
  && echo $wastefulBreakLine \
  || echo $standardBreakLine)
 
-pred() {  #get predecessor to a number
+pred() {
+    #
+    # Get predecessor to a number $1
+    #
     case $1 in
         *nine)      echo ${1%nine}eight;;
         *eight)     echo ${1%eight}seven;;
@@ -44,14 +47,20 @@ pred() {  #get predecessor to a number
     esac
 }
 
-teenpred() { #predecessor of a teen
+teenpred() {
+    #
+    # Get predecessor of a teen $1
+    #
     case $1 in
         thirteen)   echo twelve;;
         *)          echo $(crunchprefix $(pred $(uncrunchprefix ${1%teen})))teen;;
     esac
 }
 
-tenspred() { #predecessor of a multiple of ten
+tenspred() {
+    #
+    # Get predecessor of a multiple of ten $1
+    #
     case $1 in
         twenty)     echo nineteen;;
         *) echo $(crunchprefix --tens $(pred $(uncrunchprefix ${1%ty})))ty-nine;;
@@ -59,9 +68,13 @@ tenspred() { #predecessor of a multiple of ten
 }
 
 crunchprefix() {
-    #crunch number prefix to its conventional form
-    # such as three --> thir
-    # option --tens     multiples of ten are a bit different
+    #
+    # Crunch number prefix $1 to its conventional form
+    #
+    # ...such as `three` --> `thir`
+    #
+    # option `--tens` - multiples of ten are a bit different
+    #
     [ $1 = --tens ] && { tensop=true; shift; }
     case $1 in
         two)    [ -n "$tensop" ] && echo twen || echo $1;;
@@ -73,7 +86,10 @@ crunchprefix() {
     esac
 }
 
-uncrunchprefix() { #reverse crunchprefix
+uncrunchprefix() {
+    #
+    # Reverse crunchprefix $1
+    #
     case $1 in
         twen)   echo two;;
         thir)   echo three;;
@@ -84,7 +100,10 @@ uncrunchprefix() { #reverse crunchprefix
     esac
 }
 
-grammar() { #peculiarities of English grammar
+grammar() {
+    #
+    # Apply peculiarities of English grammar to text on stdin
+    #
     local oneBottle=false  #can effect the following line
     while read line; do
         line="${line/one more bottles/one more bottle}"
@@ -106,14 +125,20 @@ grammar() { #peculiarities of English grammar
     done
 }
 
-capitalize() {  #fix beginning of each line
+capitalize() {
+    #
+    # Fix capitalization of each line on stdin
+    #
     while read line; do
         echo -n ${line:0:1} | tr '[:lower:]' '[:upper:]'
         echo ${line#?}
     done
 }
 
-punctuate() {  #add punct to each line
+punctuate() {
+    #
+    # Add punctuation to each line on stdin
+    #
     while read line; do
         case "${line}" in
             [Ii]f*)     echo ${line},;;
@@ -123,7 +148,10 @@ punctuate() {  #add punct to each line
     done
 }
 
-verse () { #write one verse
+verse () {
+    #
+    # Write one verse with number $1
+    #
     local nb=$1
     echo $nb bottles of beer on the wall
     echo $nb bottles of beer
@@ -137,7 +165,10 @@ verse () { #write one verse
     echo $nb bottles of beer on the wall
 }
 
-poeticize() { #make it nice
+poeticize() {
+    #
+    # Make text on stdin nice
+    #
     while read first rest; do
         case "$rest" in
             *beer*)
@@ -153,7 +184,10 @@ poeticize() { #make it nice
     done
 }
 
-syllables() { #estimate number of syls in word
+syllables() {
+    #
+    # Estimate number of syllables in word $1
+    #
     local n=1
     case $1 in
         eleven)     n=2;; #sounds better if not considered 3