Refactor input and output parameter documentation across multiple SQL DSC scripts to enhance clarity and consistency. Updated parameter types to use backticks for better formatting. Improved descriptions for inputs and outputs, ensuring they accurately reflect the expected types and behaviors. This includes changes in scripts related to agent alerts, logins, databases, and configuration options, among others.

Author: johlju

source/Private/Get-CommandParameter.ps1

@@ -15,7 +15,7 @@
         Common parameters and optional common parameters are always excluded.
 
     .INPUTS
-        None
+        None.
 
     .OUTPUTS
         `System.String[]`

source/Public/Add-SqlDscFileGroup.ps1

@@ -21,17 +21,17 @@
         Specifies that the FileGroup should be added without confirmation.
 
     .INPUTS
-        Microsoft.SqlServer.Management.Smo.FileGroup
+        `Microsoft.SqlServer.Management.Smo.FileGroup`
 
         FileGroup objects that will be added to the Database.
 
     .OUTPUTS
         None.
 
-This cmdlet does not generate output by default.
+        This cmdlet does not generate output by default.
 
     .OUTPUTS
-        Microsoft.SqlServer.Management.Smo.FileGroup[]
+        `Microsoft.SqlServer.Management.Smo.FileGroup[]`
 
         When the PassThru parameter is specified, returns the FileGroup objects that were added.
 

source/Public/ConvertTo-SqlDscDataFile.ps1

@@ -14,12 +14,12 @@
         The DatabaseFileSpec object containing the data file configuration.
 
     .INPUTS
-        None
+        None.
 
         This command does not accept pipeline input.
 
     .OUTPUTS
-        Microsoft.SqlServer.Management.Smo.DataFile
+        `Microsoft.SqlServer.Management.Smo.DataFile`
 
         Returns a SMO DataFile object bound to the provided FileGroup.
 

source/Public/ConvertTo-SqlDscFileGroup.ps1

@@ -18,7 +18,7 @@
         None.
 
     .OUTPUTS
-        Microsoft.SqlServer.Management.Smo.FileGroup
+        `Microsoft.SqlServer.Management.Smo.FileGroup`
 
     .EXAMPLE
         $fileSpec = New-SqlDscDataFile -Name 'TestDB_Data' -FileName 'C:\SQLData\TestDB.mdf' -AsSpec

source/Public/Disable-SqlDscAgentOperator.ps1

@@ -50,12 +50,12 @@
         Refreshes the server operators collection before disabling **MyOperator**.
 
     .INPUTS
-        [Microsoft.SqlServer.Management.Smo.Server]
+        `Microsoft.SqlServer.Management.Smo.Server`
 
         Server object accepted from the pipeline (ServerObject parameter set).
 
     .INPUTS
-        [Microsoft.SqlServer.Management.Smo.Agent.Operator]
+        `Microsoft.SqlServer.Management.Smo.Agent.Operator`
 
         Operator object accepted from the pipeline (OperatorObject parameter set).
 

source/Public/Disable-SqlDscDatabaseSnapshotIsolation.ps1

@@ -55,7 +55,7 @@
         Disables snapshot isolation and returns the updated database object.
 
     .INPUTS
-        Microsoft.SqlServer.Management.Smo.Database
+        `Microsoft.SqlServer.Management.Smo.Database`
 
         The database object to modify (from Get-SqlDscDatabase).
 
@@ -65,7 +65,7 @@
         By default, no output is returned.
 
     .OUTPUTS
-        Microsoft.SqlServer.Management.Smo.Database
+        `Microsoft.SqlServer.Management.Smo.Database`
 
         When PassThru is specified, the updated database object is returned.
 #>

source/Public/Disable-SqlDscLogin.ps1

@@ -49,11 +49,12 @@
 
         Refreshes the server logins collection before disabling **MyLogin**.
     .INPUTS
-        [Microsoft.SqlServer.Management.Smo.Server]
+        `Microsoft.SqlServer.Management.Smo.Server`
 
         Server object accepted from the pipeline (ServerObject parameter set).
 
-        [Microsoft.SqlServer.Management.Smo.Login]
+    .INPUTS
+        `Microsoft.SqlServer.Management.Smo.Login`
 
         Login object accepted from the pipeline (LoginObject parameter set).
 

source/Public/Enable-SqlDscAgentOperator.ps1

@@ -38,12 +38,12 @@
         Enables the operator named **MyOperator**.
 
     .INPUTS
-        Microsoft.SqlServer.Management.Smo.Server
+        `Microsoft.SqlServer.Management.Smo.Server`
 
         When using the ServerObject parameter set, a Server object can be piped in.
 
     .INPUTS
-        Microsoft.SqlServer.Management.Smo.Agent.Operator
+        `Microsoft.SqlServer.Management.Smo.Agent.Operator`
 
         When using the OperatorObject parameter set, an Operator object can be piped in.
 

source/Public/Enable-SqlDscDatabaseSnapshotIsolation.ps1

@@ -55,7 +55,7 @@
         Enables snapshot isolation and returns the updated database object.
 
     .INPUTS
-        Microsoft.SqlServer.Management.Smo.Database
+        `Microsoft.SqlServer.Management.Smo.Database`
 
         The database object to modify (from Get-SqlDscDatabase).
 
@@ -65,7 +65,7 @@
         By default, no output is returned.
 
     .OUTPUTS
-        Microsoft.SqlServer.Management.Smo.Database
+        `Microsoft.SqlServer.Management.Smo.Database`
 
         When PassThru is specified, the updated database object is returned.
 #>

source/Public/Enable-SqlDscLogin.ps1

@@ -38,11 +38,14 @@
         Enables the login named **MyLogin**.
 
     .INPUTS
-        Microsoft.SqlServer.Management.Smo.Server
-            When using the ServerObject parameter set, a Server object can be piped in.
+        `Microsoft.SqlServer.Management.Smo.Server`
 
-        Microsoft.SqlServer.Management.Smo.Login
-            When using the LoginObject parameter set, a Login object can be piped in.
+        Server object accepted from the pipeline (ServerObject parameter set).
+
+    .INPUTS
+        `Microsoft.SqlServer.Management.Smo.Login`
+
+        Login object accepted from the pipeline (LoginObject parameter set).
 
     .OUTPUTS
         None.