Get-BuildSynopsis

Gets the task synopsis.

Syntax

Get-BuildSynopsis [-Task] Object [[-Hash] Object]

Description

Gets the specified task synopsis if it is available.

Task synopses are defined in preceding comments as

    # Synopsis: ...

or

    <#
    .Synopsis
    ...
    #>

This function may be used in Set-BuildHeader for printing task synopses.

Parameters

-Task
    The task object. During the build, the current task is available as the
    automatic variable $Task.
    
    Required?                    true
    Position?                    0

-Hash
    The cache used by external tools. Scripts may omit this parameter.
    
    Required?                    false
    Position?                    1

Outputs

String

Examples

-------------------------- EXAMPLE 1 --------------------------
# Headers: print task paths as usual and synopses in addition
Set-BuildHeader {
    param($Path)
    print Cyan "Task $Path : $(Get-BuildSynopsis $Task)"
}

# Synopsis: This task prints its own synopsis.
task Task1 {
    'My synopsis : ' + (Get-BuildSynopsis $Task)
}

Links

Set-BuildFooter
Set-BuildHeader