From: Bastian Dehn <hhaalo@arcor.de>
Date: Sun, 8 Sep 2019 16:12:12 +0000 (+0200)
Subject: add: comments restore
X-Git-Url: https://gitweb.hhaalo.de/?a=commitdiff_plain;h=3e29d97e3118c4feef35b19bbd79fc962e11f329;p=simple-backup.git

add: comments restore
---

diff --git a/restore b/restore
index b075dd8..83f16ef 100755
--- 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