New-DevartDatabaseDocumentation

Synopsis

Creates documentation for a specified schema.

Description

The cmdlet creates documentation for a specified schema.

Syntax

New-DevartDatabaseDocumentation -Connection <object> -Output <string> [-AdditionalOptions <string>] [-Format <DocumentationFormat>] [-Path <string>] [-ProjectFile <string>] [<CommonParameters>]

Parameters

-Connection <object>

Connection to the server with the specified database for which documentation will be built.

Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-Path <string>

Specify the destination directory for documentation.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-Output <string>

Specify an output file name for PDF documentation or folder name for HTML or Markdown documentation.

Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-ProjectFile <string>

The project file with *.ddoc extension.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-AdditionalOptions <string>

Specifies additional options used during creation of documentation.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

For more detailed information about additional options, see the documentation topic.

-Format <DocumentationFormat>

The documentation format.

Required? false

Position? named

Default value Html

Accept pipeline input? false

Accept wildcard characters? false

<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, InformationAction, InformationVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters.

Outputs

System.Boolean (returns true on success and false otherwise)

Examples

---------- EXAMPLE 1 ----------
$documenterResult = New-DevartDatabaseDocumentation -Connection $connection -ProjectFile "DababaseName(MsSqlServer).ddoc" -Output:"C:\Report\" -Format HTML

See Switches used in the Command line for a complete list of supported AdditionalOptions.