From 9d6464685c5fdbbaab8a9cbf5964230f7e9cf52e Mon Sep 17 00:00:00 2001 From: EsOsO Date: Mon, 3 Dec 2018 13:09:40 +0000 Subject: [PATCH] Updated docs [skip ci] --- docs/functions/Get-LoggingCallerScope.md | 50 +++++++++++++++++ docs/functions/Set-LoggingCallerScope.md | 71 ++++++++++++++++++++++++ mkdocs.yml | 2 + 3 files changed, 123 insertions(+) create mode 100644 docs/functions/Get-LoggingCallerScope.md create mode 100644 docs/functions/Set-LoggingCallerScope.md diff --git a/docs/functions/Get-LoggingCallerScope.md b/docs/functions/Get-LoggingCallerScope.md new file mode 100644 index 0000000..ed8ece9 --- /dev/null +++ b/docs/functions/Get-LoggingCallerScope.md @@ -0,0 +1,50 @@ +--- +external help file: Logging-help.xml +Module Name: Logging +online version: https://logging.readthedocs.io/en/latest/functions/Get-LoggingCallerScope.md +schema: 2.0.0 +--- + +# Get-LoggingCallerScope + +## SYNOPSIS +Returns the default caller scope + +## SYNTAX + +``` +Get-LoggingCallerScope [] +``` + +## DESCRIPTION +This function returns an int representing the scope where the invocation scope for the caller should be obtained from + +## EXAMPLES + +### EXAMPLE 1 +``` +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[https://logging.readthedocs.io/en/latest/functions/Get-LoggingCallerScope.md](https://logging.readthedocs.io/en/latest/functions/Get-LoggingCallerScope.md) + +[https://logging.readthedocs.io/en/latest/functions/Write-Log.md](https://logging.readthedocs.io/en/latest/functions/Write-Log.md) + +[https://logging.readthedocs.io/en/latest/LoggingFormat.md](https://logging.readthedocs.io/en/latest/LoggingFormat.md) + +[https://github.com/EsOsO/Logging/blob/master/Logging/public/Get-LoggingCallerScope.ps1](https://github.com/EsOsO/Logging/blob/master/Logging/public/Get-LoggingCallerScope.ps1) + diff --git a/docs/functions/Set-LoggingCallerScope.md b/docs/functions/Set-LoggingCallerScope.md new file mode 100644 index 0000000..6f0bce7 --- /dev/null +++ b/docs/functions/Set-LoggingCallerScope.md @@ -0,0 +1,71 @@ +--- +external help file: Logging-help.xml +Module Name: Logging +online version: https://logging.readthedocs.io/en/latest/functions/Set-LoggingCallerScope.md +schema: 2.0.0 +--- + +# Set-LoggingCallerScope + +## SYNOPSIS +Sets the scope from which to get the caller scope + +## SYNTAX + +``` +Set-LoggingCallerScope [[-CallerScope] ] [] +``` + +## DESCRIPTION +This function sets the scope to obtain information from the caller + +## EXAMPLES + +### EXAMPLE 1 +``` +Set-LoggingCallerScope -CallerScope 2 +``` + +### EXAMPLE 2 +``` +Set-LoggingCallerScope +``` + +It sets the caller scope to 1 + +## PARAMETERS + +### -CallerScope +Integer representing the scope to use to find the caller information. +Defaults to 1 which represent the scope of the function where Write-Log is being called from + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: $Defaults.CallerScope +Accept pipeline input: False +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[https://logging.readthedocs.io/en/latest/functions/Set-LoggingCallerScope.md](https://logging.readthedocs.io/en/latest/functions/Set-LoggingCallerScope.md) + +[https://logging.readthedocs.io/en/latest/functions/Write-Log.md](https://logging.readthedocs.io/en/latest/functions/Write-Log.md) + +[https://github.com/EsOsO/Logging/blob/master/Logging/public/Set-LoggingCallerScope.ps1](https://github.com/EsOsO/Logging/blob/master/Logging/public/Set-LoggingCallerScope.ps1) + diff --git a/mkdocs.yml b/mkdocs.yml index 7b405a3..0e9adfb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,9 +17,11 @@ nav: - Add-LoggingLevel: Add-LoggingLevel.md - Add-LoggingTarget: Add-LoggingTarget.md - Get-LoggingAvailableTarget: Get-LoggingAvailableTarget.md + - Get-LoggingCallerScope: Get-LoggingCallerScope.md - Get-LoggingDefaultFormat: Get-LoggingDefaultFormat.md - Get-LoggingDefaultLevel: Get-LoggingDefaultLevel.md - Get-LoggingTarget: Get-LoggingTarget.md + - Set-LoggingCallerScope: Set-LoggingCallerScope.md - Set-LoggingCustomTarget: Set-LoggingCustomTarget.md - Set-LoggingDefaultFormat: Set-LoggingDefaultFormat.md - Set-LoggingDefaultLevel: Set-LoggingDefaultLevel.md