From 03bd227d8941ec90eab5cf43f672f5339376d5c2 Mon Sep 17 00:00:00 2001 From: Russell Mora Date: Tue, 18 Oct 2016 13:09:11 -0400 Subject: [PATCH] (GH-1021) Added comments for document generation. --- .../helpers/functions/Get-ChocolateyWebFile.ps1 | 5 +++++ src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 | 5 +++++ .../helpers/functions/Get-WebFileName.ps1 | 5 +++++ .../helpers/functions/Get-WebHeaders.ps1 | 5 +++++ .../helpers/functions/Install-ChocolateyPackage.ps1 | 5 +++++ 5 files changed, 25 insertions(+) diff --git a/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 b/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 index 93c53dab00..067600fc01 100644 --- a/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 @@ -121,6 +121,11 @@ https://support.microsoft.com/en-us/kb/811833 for more details. The recommendation is to use at least SHA256. +.PARAMETER Credential +OPTIONAL - A System.Net.ICredentials object that contains credentials to +use to authenticate to the URL server. This is just ultimately passed +onto System.Net.HttpWebRequest Crentials property. Available in 0.9.11+ + .PARAMETER Options OPTIONAL - Specify custom headers. Available in 0.9.10+. diff --git a/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 b/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 index 249efdd168..ba1870626b 100644 --- a/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 @@ -57,6 +57,11 @@ package folder next to the install script, the path will be like The user agent to use as part of the request. Defaults to 'chocolatey command line'. +.PARAMETER Credential +OPTIONAL - A System.Net.ICredentials object that contains credentials to +use to authenticate to the URL server. This is just ultimately passed +onto System.Net.HttpWebRequest Crentials property. Available in 0.9.11+ + .PARAMETER PassThru DO NOT USE - holdover from original function. diff --git a/src/chocolatey.resources/helpers/functions/Get-WebFileName.ps1 b/src/chocolatey.resources/helpers/functions/Get-WebFileName.ps1 index 610e6d564a..0a2fb80c90 100644 --- a/src/chocolatey.resources/helpers/functions/Get-WebFileName.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-WebFileName.ps1 @@ -53,6 +53,11 @@ from the url response. The user agent to use as part of the request. Defaults to 'chocolatey command line'. +.PARAMETER Credential +OPTIONAL - A System.Net.ICredentials object that contains credentials to +use to authenticate to the URL server. This is just ultimately passed +onto System.Net.HttpWebRequest Crentials property. Available in 0.9.11+ + .PARAMETER IgnoredArguments Allows splatting with arguments that do not apply. Do not use directly. diff --git a/src/chocolatey.resources/helpers/functions/Get-WebHeaders.ps1 b/src/chocolatey.resources/helpers/functions/Get-WebHeaders.ps1 index b52a0c5b79..16b35d5a02 100644 --- a/src/chocolatey.resources/helpers/functions/Get-WebHeaders.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-WebHeaders.ps1 @@ -38,6 +38,11 @@ This is the url to get a request/response from. The user agent to use as part of the request. Defaults to 'chocolatey command line'. +.PARAMETER Credential +OPTIONAL - A System.Net.ICredentials object that contains credentials to +use to authenticate to the URL server. This is just ultimately passed +onto System.Net.HttpWebRequest Crentials property. Available in 0.9.11+ + .PARAMETER IgnoredArguments Allows splatting with arguments that do not apply. Do not use directly. diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 index 58f41e414c..af13a71bcc 100644 --- a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 +++ b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 @@ -164,6 +164,11 @@ https://support.microsoft.com/en-us/kb/811833 for more details. The recommendation is to use at least SHA256. +.PARAMETER Credential +OPTIONAL - A System.Net.ICredentials object that contains credentials to +use to authenticate to the URL server. This is just ultimately passed +onto System.Net.HttpWebRequest Crentials property. Available in 0.9.11+ + .PARAMETER Options OPTIONAL - Specify custom headers. Available in 0.9.10+.