Skip to content

Commit

Permalink
Updated docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
EsOsO committed Dec 3, 2018
1 parent 0f0f893 commit 9d64646
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/functions/Get-LoggingCallerScope.md
Original file line number Diff line number Diff line change
@@ -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 [<CommonParameters>]
```

## 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)

71 changes: 71 additions & 0 deletions docs/functions/Set-LoggingCallerScope.md
Original file line number Diff line number Diff line change
@@ -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] <Int32>] [<CommonParameters>]
```

## 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)
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9d64646

Please sign in to comment.