Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PrzemyslawKlys committed Sep 29, 2024
1 parent 34cac07 commit 524b6f0
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 20 deletions.
29 changes: 11 additions & 18 deletions Docs/Get-PowerShellAssemblyMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-PowerShellAssemblyMetadata

## SYNOPSIS
Gets the cmdlets and aliases in a dotnet assembly.
{{ Fill in the Synopsis }}

## SYNTAX

Expand All @@ -21,23 +21,25 @@ Get-PowerShellAssemblyMetadata [-Path] <String> [-ProgressAction <ActionPreferen

## EXAMPLES

### EXAMPLE 1
```
Get-PowerShellAssemblyMetadata -Path MyModule.dll
### Example 1
```powershell
PS C:\> {{ Add example code here }}
```

{{ Add example description here }}

## PARAMETERS

### -Path
The assembly to inspect.
{{ Fill Path Description }}

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -63,20 +65,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
This requires the System.Reflection.MetadataLoadContext assembly to be
loaded through Add-Type.
WinPS (5.1) will also need to load its deps
System.Memory
System.Collections.Immutable
System.Reflection.Metadata
System.Runtime.CompilerServices.Unsafe
https://www.nuget.org/packages/System.Reflection.MetadataLoadContext
Copyright: (c) 2024, Jordan Borean (@jborean93) \<[email protected]\>
MIT License (see LICENSE or https://opensource.org/licenses/MIT)
## RELATED LINKS
36 changes: 34 additions & 2 deletions Docs/New-ConfigurationBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ New-ConfigurationBuild [-Enable] [-DeleteTargetModuleBeforeBuild] [-MergeModuleO
[[-NETProjectName] <String>] [-NETExcludeMainLibrary] [[-NETExcludeLibraryFilter] <String[]>]
[[-NETIgnoreLibraryOnLoad] <String[]>] [[-NETBinaryModule] <String[]>] [-NETHandleAssemblyWithSameName]
[-NETLineByLineAddType] [-NETBinaryModuleCmdletScanDisabled] [-NETMergeLibraryDebugging]
[-NETResolveBinaryConflicts] [[-NETResolveBinaryConflictsName] <String>] [[-NETSearchClass] <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
[-NETResolveBinaryConflicts] [[-NETResolveBinaryConflictsName] <String>] [-NETBinaryModuleDocumenation]
[-NETDoNotCopyLibrariesRecursively] [[-NETSearchClass] <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -548,6 +549,37 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -NETBinaryModuleDocumenation
Include documentation for binary modules, this is useful if you have a lot of binary modules and you want to include documentation for them (if available in XML format)
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: NETDocumentation

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -NETDoNotCopyLibrariesRecursively
Do not copy libraries recursively.
Normally all libraries are copied recursively, but this option disables that functionality so it won't copy subfolders of libraries.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -NETSearchClass
Provide a name for class when using NETResolveBinaryConflicts or NETResolveBinaryConflictsName.
By default it uses \`$LibraryName.Initialize\` however that may not be always the case
Expand Down

0 comments on commit 524b6f0

Please sign in to comment.