Skip to content

Commit d3ffbb7

Browse files
StartAutomatingStartAutomating
authored andcommitted
Core Inline Transpiler : Adding -LinePattern (fixes #197)
1 parent 432e8ce commit d3ffbb7

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

docs/New-PipeScript.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,79 @@ If set, will weakly type parameters generated by reflection.
138138
|--------------|--------|-------|-------------|
139139
|```[Switch]```|false |named |false |
140140
---
141+
#### **FunctionName**
142+
143+
The name of the function to create.
144+
145+
146+
147+
|Type |Requried|Postion|PipelineInput|
148+
|--------------|--------|-------|-------------|
149+
|```[String]```|false |9 |false |
150+
---
151+
#### **FunctionType**
152+
153+
The type of the function to create. This will be ignored if -FunctionName is not passed.
154+
155+
156+
157+
|Type |Requried|Postion|PipelineInput|
158+
|--------------|--------|-------|-------------|
159+
|```[String]```|false |10 |false |
160+
---
161+
#### **Description**
162+
163+
A description of the script's functionality. If provided with -Synopsis, will generate help.
164+
165+
166+
167+
|Type |Requried|Postion|PipelineInput|
168+
|--------------|--------|-------|-------------|
169+
|```[String]```|false |11 |false |
170+
---
171+
#### **Synopsis**
172+
173+
A short synopsis of the script's functionality. If provided with -Description, will generate help.
174+
175+
176+
177+
|Type |Requried|Postion|PipelineInput|
178+
|--------------|--------|-------|-------------|
179+
|```[String]```|false |12 |false |
180+
---
181+
#### **Example**
182+
183+
A list of examples to use in help. Will be ignored if -Synopsis and -Description are not passed.
184+
185+
186+
187+
|Type |Requried|Postion|PipelineInput|
188+
|----------------|--------|-------|-------------|
189+
|```[String[]]```|false |13 |false |
190+
---
191+
#### **Link**
192+
193+
A list of links to use in help. Will be ignored if -Synopsis and -Description are not passed.
194+
195+
196+
197+
|Type |Requried|Postion|PipelineInput|
198+
|----------------|--------|-------|-------------|
199+
|```[String[]]```|false |14 |false |
200+
---
201+
#### **Attribute**
202+
203+
A list of attributes to declare on the scriptblock.
204+
205+
206+
207+
|Type |Requried|Postion|PipelineInput|
208+
|----------------|--------|-------|-------------|
209+
|```[String[]]```|false |15 |false |
210+
---
141211
### Syntax
142212
```PowerShell
143-
New-PipeScript [[-Parameter] <Object>] [[-DynamicParameter] <ScriptBlock>] [[-Begin] <ScriptBlock>] [[-Process] <ScriptBlock>] [[-End] <ScriptBlock>] [[-Header] <String>] [-AutoParameter] [[-AutoParameterType] <Type>] [[-ParameterHelp] <IDictionary>] [-WeaklyTyped] [<CommonParameters>]
213+
New-PipeScript [[-Parameter] <Object>] [[-DynamicParameter] <ScriptBlock>] [[-Begin] <ScriptBlock>] [[-Process] <ScriptBlock>] [[-End] <ScriptBlock>] [[-Header] <String>] [-AutoParameter] [[-AutoParameterType] <Type>] [[-ParameterHelp] <IDictionary>] [-WeaklyTyped] [[-FunctionName] <String>] [[-FunctionType] <String>] [[-Description] <String>] [[-Synopsis] <String>] [[-Example] <String[]>] [[-Link] <String[]>] [[-Attribute] <String[]>] [<CommonParameters>]
144214
```
145215
---
146216

0 commit comments

Comments
 (0)