fixup generated docs

chocolatey · Jun 3, 2016 · eee6871 · eee6871
1 parent a3991ff
commit eee6871
Show file tree

Hide file tree

Showing 20 changed files with 319 additions and 65 deletions.
diff --git a/docs/generated/HelpersFormatFileSize.md b/docs/generated/HelpersFormatFileSize.md
@@ -17,6 +17,7 @@ Formats file size into a human readable format.
 ## Notes
 
 Available in 0.9.10+.
+
 This function is not part of the API.
 
 ## Aliases
@@ -51,7 +52,7 @@ Property               | Value
 ---------------------- | -----
 Aliases                | 
 Required?              | false
-Position?              | 2
+Position?              | named
 Default Value          | 
 Accept Pipeline Input? | false
 

diff --git a/docs/generated/HelpersGetFtpFile.md b/docs/generated/HelpersGetFtpFile.md
@@ -80,7 +80,7 @@ Property               | Value
 ---------------------- | -----
 Aliases                | 
 Required?              | false
-Position?              | 3
+Position?              | 4
 Default Value          | 
 Accept Pipeline Input? | false
 

diff --git a/docs/generated/HelpersGetWebFile.md b/docs/generated/HelpersGetWebFile.md
@@ -7,9 +7,9 @@ available.
 
 ~~~powershell
 Get-WebFile `
-  [-Url <Object>] `
-  [-FileName <Object>] `
-  [-UserAgent <Object>] `
+  [-Url <String>] `
+  [-FileName <String>] `
+  [-UserAgent <String>] `
   [-Passthru] `
   [-Quiet] `
   [-Options <Hashtable>] `
@@ -40,7 +40,7 @@ None
 
 ## Parameters
 
-###  -Url [&lt;Object&gt;]
+###  -Url [&lt;String&gt;]
 This is the url to download the file from. Prefer HTTPS when available.
 
 Property               | Value
@@ -51,7 +51,7 @@ Position?              | 1
 Default Value          | 
 Accept Pipeline Input? | false
 
-###  -FileName [&lt;Object&gt;]
+###  -FileName [&lt;String&gt;]
 This is the full path to the file to create. If downloading to the
 package folder next to the install script, the path will be like
 `"$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\file.exe"`
@@ -64,7 +64,7 @@ Position?              | 2
 Default Value          | 
 Accept Pipeline Input? | false
 
-###  -UserAgent [&lt;Object&gt;]
+###  -UserAgent [&lt;String&gt;]
 The user agent to use as part of the request. Defaults to 'chocolatey
 command line'.
 
@@ -105,7 +105,7 @@ Property               | Value
 ---------------------- | --------------
 Aliases                | 
 Required?              | false
-Position?              | 4
+Position?              | named
 Default Value          | @{Headers=@{}}
 Accept Pipeline Input? | false
 
@@ -116,7 +116,7 @@ Property               | Value
 ---------------------- | -----
 Aliases                | 
 Required?              | false
-Position?              | 5
+Position?              | named
 Default Value          | 
 Accept Pipeline Input? | false
 

diff --git a/docs/generated/HelpersGetWebFileName.md b/docs/generated/HelpersGetWebFileName.md
@@ -9,7 +9,7 @@ the original file name for a file.
 Get-WebFileName `
   [-Url <String>] `
   -DefaultName <String> `
-  [-UserAgent <Object>] `
+  [-UserAgent <String>] `
   [-IgnoredArguments <Object[]>] [<CommonParameters>]
 ~~~
 
@@ -68,7 +68,7 @@ Position?              | 2
 Default Value          | 
 Accept Pipeline Input? | false
 
-###  -UserAgent [&lt;Object&gt;]
+###  -UserAgent [&lt;String&gt;]
 The user agent to use as part of the request. Defaults to 'chocolatey
 command line'.
 

diff --git a/docs/generated/HelpersGetWebHeaders.md b/docs/generated/HelpersGetWebHeaders.md
@@ -6,8 +6,8 @@ Gets the request/response headers for a url.
 
 ~~~powershell
 Get-WebHeaders `
-  [-Url <Object>] `
-  [-UserAgent <Object>] `
+  [-Url <String>] `
+  [-UserAgent <String>] `
   [-IgnoredArguments <Object[]>] [<CommonParameters>]
 ~~~
 
@@ -35,7 +35,7 @@ None
 
 ## Parameters
 
-###  -Url [&lt;Object&gt;]
+###  -Url [&lt;String&gt;]
 This is the url to get a request/response from.
 
 Property               | Value
@@ -46,7 +46,7 @@ Position?              | 1
 Default Value          | 
 Accept Pipeline Input? | false
 
-###  -UserAgent [&lt;Object&gt;]
+###  -UserAgent [&lt;String&gt;]
 The user agent to use as part of the request. Defaults to 'chocolatey
 command line'.
 
@@ -65,7 +65,7 @@ Property               | Value
 ---------------------- | -----
 Aliases                | 
 Required?              | false
-Position?              | 3
+Position?              | named
 Default Value          | 
 Accept Pipeline Input? | false
 

diff --git a/docs/generated/HelpersInstallChocolateyDesktopLink.md b/docs/generated/HelpersInstallChocolateyDesktopLink.md
@@ -25,6 +25,8 @@ If this errors, such as it will if being installed under the local
 SYSTEM account, it will display a warning instead of failing a package
 installation.
 
+Will not throw an error if it fails.
+
 ## Aliases
 
 None

diff --git a/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md b/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md
@@ -1,6 +1,8 @@
 # Install-ChocolateyEnvironmentVariable
 
-Creates a persistent environment variable
+**NOTE:** Administrative Access Required when `-VariableType 'Machine'.`
+
+Creates a persistent environment variable.
 
 ## Syntax
 
@@ -17,15 +19,17 @@ Install-ChocolateyEnvironmentVariable `
 Install-ChocolateyEnvironmentVariable creates an environment variable
 with the specified name and value. The variable is persistent and
 will remain after reboots and across multiple PowerShell and command
-line sessions. The variable can be scoped either to the user or to
-the machine. If machine level scoping is specified, the command is
+line sessions. The variable can be scoped either to the User or to
+the Machine. If Machine level scoping is specified, the command is
 elevated to an administrative session.
 
 ## Notes
 
 This command will assert UAC/Admin privileges on the machine when
 `-VariableType Machine`.
 
+This will add the environment variable to the current session.
+
 ## Aliases
 
 None
@@ -99,7 +103,7 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err
 
 ~~~powershell
 
-# Creates a User environmet variable "JAVA_HOME" pointing to
+# Creates a User environment variable "JAVA_HOME" pointing to
 # "d:\oracle\jdk\bin".
 Install-ChocolateyEnvironmentVariable "JAVA_HOME" "d:\oracle\jdk\bin"
 ~~~
@@ -108,7 +112,7 @@ Install-ChocolateyEnvironmentVariable "JAVA_HOME" "d:\oracle\jdk\bin"
 
 ~~~powershell
 
-# Creates a User environmet variable "_NT_SYMBOL_PATH" pointing to
+# Creates a User environment variable "_NT_SYMBOL_PATH" pointing to
 # "symsrv*symsrv.dll*f:\localsymbols*http://msdl.microsoft.com/download/symbols".
 # The command will be elevated to admin priviledges.
 Install-ChocolateyEnvironmentVariable `
@@ -117,8 +121,17 @@ Install-ChocolateyEnvironmentVariable `
   -VariableType Machine
 ~~~
 
+**EXAMPLE 3**
+
+~~~powershell
+
+# Remove an environment variable
+Install-ChocolateyEnvironmentVariable -VariableName 'bob' -VariableValue $null
+~~~
+
 ## Links
 
+ * [[Uninstall-ChocolateyEnvironmentVariable|HelpersUninstallChocolateyEnvironmentVariable]]
  * [[Get-EnvironmentVariable|HelpersGetEnvironmentVariable]]
  * [[Set-EnvironmentVariable|HelpersSetEnvironmentVariable]]
  * [[Install-ChocolateyPath|HelpersInstallChocolateyPath]]

diff --git a/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md b/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md
@@ -1,13 +1,15 @@
 # Install-ChocolateyExplorerMenuItem
 
+**NOTE:** Administrative Access Required.
+
 Creates a windows explorer context menu item that can be associated with
 a command
 
 ## Syntax
 
 ~~~powershell
 Install-ChocolateyExplorerMenuItem `
-  [-MenuKey <String>] `
+  -MenuKey <String> `
   [-MenuLabel <String>] `
   [-Command <String>] `
   [-Type <String>] `
@@ -46,13 +48,13 @@ None
 
 ## Parameters
 
-###  -MenuKey [&lt;String&gt;]
+###  -MenuKey &lt;String&gt;
 A unique string to identify this menu item in the registry
 
 Property               | Value
 ---------------------- | -----
 Aliases                | 
-Required?              | false
+Required?              | true
 Position?              | 1
 Default Value          | 
 Accept Pipeline Input? | false
@@ -98,7 +100,7 @@ Property               | Value
 ---------------------- | -----
 Aliases                | 
 Required?              | false
-Position?              | 5
+Position?              | named
 Default Value          | 
 Accept Pipeline Input? | false
 

diff --git a/docs/generated/HelpersInstallChocolateyFileAssociation.md b/docs/generated/HelpersInstallChocolateyFileAssociation.md
@@ -1,13 +1,15 @@
 # Install-ChocolateyFileAssociation
 
+**NOTE:** Administrative Access Required.
+
 Creates an association between a file extension and a executable.
 
 ## Syntax
 
 ~~~powershell
 Install-ChocolateyFileAssociation `
-  [-Extension <String>] `
-  [-Executable <String>] `
+  -Extension <String> `
+  -Executable <String> `
   [-IgnoredArguments <Object[]>] [<CommonParameters>]
 ~~~
 
@@ -36,24 +38,24 @@ None
 
 ## Parameters
 
-###  -Extension [&lt;String&gt;]
+###  -Extension &lt;String&gt;
 The file extension to be associated.
 
 Property               | Value
 ---------------------- | -----
 Aliases                | 
-Required?              | false
+Required?              | true
 Position?              | 1
 Default Value          | 
 Accept Pipeline Input? | false
 
-###  -Executable [&lt;String&gt;]
+###  -Executable &lt;String&gt;
 The path to the application's executable to be associated.
 
 Property               | Value
 ---------------------- | -----
 Aliases                | 
-Required?              | false
+Required?              | true
 Position?              | 2
 Default Value          | 
 Accept Pipeline Input? | false
@@ -65,7 +67,7 @@ Property               | Value
 ---------------------- | -----
 Aliases                | 
 Required?              | false
-Position?              | 3
+Position?              | named
 Default Value          | 
 Accept Pipeline Input? | false
 

diff --git a/docs/generated/HelpersInstallChocolateyInstallPackage.md b/docs/generated/HelpersInstallChocolateyInstallPackage.md
@@ -1,5 +1,7 @@
 # Install-ChocolateyInstallPackage
 
+**NOTE:** Administrative Access Required.
+
 Installs software into "Programs and Features". Use
 Install-ChocolateyPackage when software must be downloaded first.
 
@@ -22,6 +24,8 @@ This will run an installer (local file) on your machine.
 
 ## Notes
 
+This command will assert UAC/Admin privileges on the machine.
+
 If you are embedding files into a package, ensure that you have the
 rights to redistribute those files if you are sharing this package
 publicly (like on the [community feed](https://chocolatey.org/packages)). Otherwise, please use

diff --git a/docs/generated/HelpersInstallChocolateyPackage.md b/docs/generated/HelpersInstallChocolateyPackage.md
@@ -1,5 +1,7 @@
 # Install-ChocolateyPackage
 
+**NOTE:** Administrative Access Required.
+
 Installs software into "Programs and Features" based on a remote file
 download. Use Install-ChocolateyInstallPackage when local or embedded
 file.

diff --git a/docs/generated/HelpersInstallChocolateyPath.md b/docs/generated/HelpersInstallChocolateyPath.md
@@ -1,5 +1,7 @@
 # Install-ChocolateyPath
 
+**NOTE:** Administrative Access Required when `-PathType 'Machine'.`
+
 This puts a directory to the PATH environment variable.
 
 ## Syntax
@@ -18,7 +20,9 @@ correctly shows up on the right PATH.
 
 ## Notes
 
-Requires admin privileges if `PathType = 'Machine'`.
+This command will assert UAC/Admin privileges on the machine if
+`-PathType 'Machine'`.
+
 This is used when the application/tool is not being linked by Chocolatey
 (not in the lib folder).
 
@@ -83,7 +87,7 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err
  **EXAMPLE 1**
 
 ~~~powershell
-Install-ChocolateyPath "$($env:SystemDrive)\tools\gittfs"
+Install-ChocolateyPath -PathToInstall "$($env:SystemDrive)\tools\gittfs"
 
 ~~~
 

diff --git a/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md b/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md
@@ -11,6 +11,10 @@ Install-ChocolateyPinnedTaskBarItem `
 ~~~
 
 
+## Notes
+
+Does not work with SYSTEM, but does not error. It warns with the error
+message.
 
 ## Aliases