From d7320130f69776e2f5ca3dd3c660d4f52ff358b1 Mon Sep 17 00:00:00 2001 From: EsOsO Date: Thu, 4 Apr 2019 15:32:13 +0000 Subject: [PATCH] Updated docs [skip ci] --- docs/functions/Add-LoggingLevel.md | 2 +- docs/functions/Add-LoggingTarget.md | 2 +- docs/functions/Get-LoggingAvailableTarget.md | 2 +- docs/functions/Get-LoggingCallerScope.md | 2 +- docs/functions/Get-LoggingDefaultFormat.md | 2 +- docs/functions/Get-LoggingDefaultLevel.md | 2 +- docs/functions/Get-LoggingTarget.md | 2 +- docs/functions/Set-LoggingCallerScope.md | 2 +- docs/functions/Set-LoggingCustomTarget.md | 2 +- docs/functions/Set-LoggingDefaultFormat.md | 2 +- docs/functions/Set-LoggingDefaultLevel.md | 10 +++++++--- docs/functions/Wait-Logging.md | 2 +- docs/functions/Write-Log.md | 2 +- 13 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/functions/Add-LoggingLevel.md b/docs/functions/Add-LoggingLevel.md index 2fea429..78ecc2b 100644 --- a/docs/functions/Add-LoggingLevel.md +++ b/docs/functions/Add-LoggingLevel.md @@ -70,7 +70,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Add-LoggingTarget.md b/docs/functions/Add-LoggingTarget.md index 2838569..359874c 100644 --- a/docs/functions/Add-LoggingTarget.md +++ b/docs/functions/Add-LoggingTarget.md @@ -64,7 +64,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Get-LoggingAvailableTarget.md b/docs/functions/Get-LoggingAvailableTarget.md index 6ccf2da..5750399 100644 --- a/docs/functions/Get-LoggingAvailableTarget.md +++ b/docs/functions/Get-LoggingAvailableTarget.md @@ -29,7 +29,7 @@ Get-LoggingAvailableTarget ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Get-LoggingCallerScope.md b/docs/functions/Get-LoggingCallerScope.md index 7ae457b..d276805 100644 --- a/docs/functions/Get-LoggingCallerScope.md +++ b/docs/functions/Get-LoggingCallerScope.md @@ -29,7 +29,7 @@ Get-LoggingCallerScope ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Get-LoggingDefaultFormat.md b/docs/functions/Get-LoggingDefaultFormat.md index 1de295e..9b44d72 100644 --- a/docs/functions/Get-LoggingDefaultFormat.md +++ b/docs/functions/Get-LoggingDefaultFormat.md @@ -29,7 +29,7 @@ Get-LoggingDefaultFormat ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Get-LoggingDefaultLevel.md b/docs/functions/Get-LoggingDefaultLevel.md index 1a673c0..a678137 100644 --- a/docs/functions/Get-LoggingDefaultLevel.md +++ b/docs/functions/Get-LoggingDefaultLevel.md @@ -29,7 +29,7 @@ Get-LoggingDefaultLevel ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Get-LoggingTarget.md b/docs/functions/Get-LoggingTarget.md index c7f3cc5..5dc1992 100644 --- a/docs/functions/Get-LoggingTarget.md +++ b/docs/functions/Get-LoggingTarget.md @@ -29,7 +29,7 @@ Get-LoggingTarget ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Set-LoggingCallerScope.md b/docs/functions/Set-LoggingCallerScope.md index 0ce84b3..cf0cfd0 100644 --- a/docs/functions/Set-LoggingCallerScope.md +++ b/docs/functions/Set-LoggingCallerScope.md @@ -52,7 +52,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Set-LoggingCustomTarget.md b/docs/functions/Set-LoggingCustomTarget.md index 1be3e7d..9df3869 100644 --- a/docs/functions/Set-LoggingCustomTarget.md +++ b/docs/functions/Set-LoggingCustomTarget.md @@ -45,7 +45,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Set-LoggingDefaultFormat.md b/docs/functions/Set-LoggingDefaultFormat.md index b2d25cb..09893a1 100644 --- a/docs/functions/Set-LoggingDefaultFormat.md +++ b/docs/functions/Set-LoggingDefaultFormat.md @@ -51,7 +51,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Set-LoggingDefaultLevel.md b/docs/functions/Set-LoggingDefaultLevel.md index c23a8fd..e4ea0b9 100644 --- a/docs/functions/Set-LoggingDefaultLevel.md +++ b/docs/functions/Set-LoggingDefaultLevel.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Set-LoggingDefaultLevel ## SYNOPSIS -Sets a global logging severity level +Sets a global logging severity level. ## SYNTAX @@ -17,7 +17,8 @@ Set-LoggingDefaultLevel -Level [] ``` ## DESCRIPTION -This function sets a global logging severity level +This function sets a global logging severity level. +Log messages written with a lower logging level will be discarded. ## EXAMPLES @@ -26,6 +27,9 @@ This function sets a global logging severity level Set-LoggingDefaultLevel -Level ERROR ``` +PS C:\\\> Write-Log -Level INFO -Message "Test" +=\> Discarded. + ## PARAMETERS ### -Level @@ -44,7 +48,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Wait-Logging.md b/docs/functions/Wait-Logging.md index ec04306..90aa9a1 100644 --- a/docs/functions/Wait-Logging.md +++ b/docs/functions/Wait-Logging.md @@ -29,7 +29,7 @@ Wait-Logging ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/functions/Write-Log.md b/docs/functions/Write-Log.md index 7f6aa52..e89aa63 100644 --- a/docs/functions/Write-Log.md +++ b/docs/functions/Write-Log.md @@ -120,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS