add: comments restore

diff --git a/restore b/restore
index b075dd894e9a7c8352fe6aba8cdc3f0cfaeb093f..83f16ef6ead1690dbc70876bc424bbfd1d1b1003 100755 (executable)
--- a/restore
+++ b/restore
@@ -1,6 +1,8 @@
 #!/bin/bash
 # vim: tabstop=8 colorcolumn=80
 
+## @fn usage()
+## @brief Zeigt die Hilfe an
 useage()
 {
        echo "restore -d <Datum> -n <Nummer> -r <Rechner> -p <Pfad>"
@@ -12,12 +14,16 @@ useage()
        echo
 }
 
+## @fn SetDefaultVariables()
+## @brief setzt defaults
 SetDefaultVariables()
 {
        backpath="/images/backup"
        backname="sicherung"
 }
 
+## @fn ReadArguments()
+## @brief Einlesung der Konsolenargumente
 ReadArguments()
 {
        while getopts "d:n:r:p:h" optname; do
@@ -48,6 +54,8 @@ ReadArguments()
        fi
 }
 
+## @fn printStripLine()
+## @brief Gibt einen Trennungsstreifen auf der Konsole aus
 printfStripLine()
 {
        printf "####################"
@@ -56,6 +64,8 @@ printfStripLine()
        printf "####################\n"
 }
 
+## @fn RestoreData()
+## @brief Wiederherstellung der Daten
 RestoreData()
 {
        remoteuser=$(echo $rechner | sed 's/\(.*\)@.*/\1/')
@@ -93,6 +103,8 @@ RestoreData()
                $remoteLogin:$pfad
 }
 
+## @fn main()
+## @brief Ablauf des Skripts
 main()
 {
        SetDefaultVariables