Textual changes

This commit is contained in:
Michael Boelen 2019-07-10 20:22:31 +02:00
parent e4498be840
commit ce263f8cd6
No known key found for this signature in database
GPG Key ID: 26141F77A09D7F04

View File

@ -254,6 +254,7 @@
################################################################################ ################################################################################
# Name : CheckUpdates() # Name : CheckUpdates()
# Description : Determine if there is an update available # Description : Determine if there is an update available
#
# Returns : <nothing> # Returns : <nothing>
# Usage : CheckUpdates # Usage : CheckUpdates
# Use PROGRAM_LV (latest version) and compare it with actual version (PROGRAM_AC) # Use PROGRAM_LV (latest version) and compare it with actual version (PROGRAM_AC)
@ -288,8 +289,9 @@
################################################################################ ################################################################################
# Name : CleanUp() # Name : CleanUp()
# Description : Cleanup service # Description : Delete PID and temporary files, stop execution (exit code 1)
# Returns : <nothing> #
# Usage : this function is triggered by a manual break by user
################################################################################ ################################################################################
CleanUp() { CleanUp() {
@ -304,7 +306,8 @@
################################################################################ ################################################################################
# Name : ContainsString() # Name : ContainsString()
# Description : Search a specific string (or regular expression) in another # Description : Search a specific string (or regular expression) in another
# Returns : (0 - True, 1 - False) #
# Returns : True (0) or False (1)
# Usage : if ContainsString "needle" "there is a needle in the haystack"; echo "Found"; else "Not found"; fi # Usage : if ContainsString "needle" "there is a needle in the haystack"; echo "Found"; else "Not found"; fi
################################################################################ ################################################################################
@ -319,11 +322,9 @@
################################################################################ ################################################################################
# Name : CountTests() # Name : CountTests()
# Description : Count the number of tests performed # Description : Counter for the number of tests performed
# #
# Input : <nothing> # Usage : Call CountTests to increase number by 1
# Returns : <nothing>
# Usage : CountTests
################################################################################ ################################################################################
CountTests() { CountTests() {
@ -335,7 +336,6 @@
# Name : CreateTempFile() # Name : CreateTempFile()
# Description : Creates a temporary file # Description : Creates a temporary file
# #
# Input : <nothing>
# Returns : TEMP_FILE (variable) # Returns : TEMP_FILE (variable)
# Usage : CreateTempFile # Usage : CreateTempFile
# if [ ! "${TEMP_FILE}" = "" ]; then # if [ ! "${TEMP_FILE}" = "" ]; then
@ -367,7 +367,7 @@
# Name : DirectoryExists() # Name : DirectoryExists()
# Description : Check if a directory exists # Description : Check if a directory exists
# #
# Returns : 0 (directory exists), 1 (directory does not exist) # Returns : True (0) or False (1)
# Usage : if DirectoryExists; then echo "it exists"; else echo "It does not exist"; fi # Usage : if DirectoryExists; then echo "it exists"; else echo "It does not exist"; fi
################################################################################ ################################################################################