Improve the comment-based section

This commit is contained in:
Markus Fleschutz 2021-07-13 19:03:30 +02:00
parent b8d73c8cc7
commit e85b2a5bd5
6 changed files with 60 additions and 24 deletions

View File

@ -1,8 +1,14 @@
<#
.SYNTAX add-firewall-rules.ps1 [<path-to-executables>]
.DESCRIPTION adds firewall rules for the given executables, administrator rights are required
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
.SYNOPSIS
add-firewall-rules.ps1 [<path-to-executables>]
.DESCRIPTION
Adds firewall rules for the given executables (needs administrator rights)
.EXAMPLE
PS> .\add-firewall-rules.ps1 C:\MyApp\bin
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz / License: CC0
#>
#Requires -RunAsAdministrator

View File

@ -1,8 +1,14 @@
<#
.SYNTAX add-memo.ps1 [<text>]
.DESCRIPTION adds the given memo text to $HOME/Memos.csv
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
.SYNOPSIS
add-memo.ps1 [<text>]
.DESCRIPTION
Adds the given memo text to $HOME/Memos.csv
.EXAMPLE
PS> .\add-memo.ps1 "Buy apples"
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz / License: CC0
#>
param($Text = "")

View File

@ -1,8 +1,14 @@
<#
.SYNTAX alert.ps1 [<message>]
.DESCRIPTION handle and escalate the given alert message
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
.SYNOPSIS
alert.ps1 [<message>]
.DESCRIPTION
Handle and escalate the given alert message
.EXAMPLE
PS> .\alert.ps1 "Harddisk failure"
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz / License: CC0
#>
param($Message = "")

View File

@ -1,8 +1,14 @@
<#
.SYNTAX cd-desktop.ps1
.DESCRIPTION go to the user's desktop folder
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
.SYNOPSIS
cd-desktop.ps1
.DESCRIPTION
Go to the user's desktop folder
.EXAMPLE
PS> .\cd-desktop.ps1
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz / License: CC0
#>
$TargetDir = resolve-path "$HOME/Desktop"

View File

@ -1,8 +1,14 @@
<#
.SYNTAX cd-docs.ps1
.DESCRIPTION go to the user's documents folder
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
.SYNOPSIS
cd-docs.ps1
.DESCRIPTION
Go to the user's documents folder
.EXAMPLE
PS> .\cd-docs.ps1
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz / License: CC0
#>
$TargetDir = resolve-path "$HOME/Documents"

View File

@ -1,8 +1,14 @@
<#
.SYNTAX cd-downloads.ps1
.DESCRIPTION go to the user's downloads folder
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
.SYNOPSIS
cd-downloads.ps1
.DESCRIPTION
go to the user's downloads folder
.EXAMPLE
PS> .\cd-downloads.ps1
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz / License: CC0
#>
$TargetDir = resolve-path "$HOME/Downloads"