Commit build changes [ci skip]

MathieuBuisson · Jul 2, 2017 · 64e5e46 · 64e5e46
1 parent a502db1
commit 64e5e46
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 1 deletion.
diff --git a/PSCodeHealth/PSCodeHealth.psd1 b/PSCodeHealth/PSCodeHealth.psd1
@@ -12,7 +12,7 @@
 RootModule = '.\PSCodeHealth.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.1.146'
+ModuleVersion = '0.1.147'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/InternalFunctions/New-PSCodeHealthTableData.md b/docs/InternalFunctions/New-PSCodeHealthTableData.md
@@ -0,0 +1,56 @@
+# New-PSCodeHealthTableData
+
+## SYNOPSIS
+Generate table rows for the HTML report, based on the data contained in a PSCodeHealth.Overall.HealthReport object.
+
+## SYNTAX
+
+```
+New-PSCodeHealthTableData [-HealthReport] <PSObject>
+```
+
+## DESCRIPTION
+Generate table rows for the HTML report, based on the data contained in a PSCodeHealth.Overall.HealthReport object.
+
+This provides the rows for the following tables :  
+  - Best Practices (per function)  
+  - Maintainability (per function)  
+  - Failed Tests Details  
+  - Test Coverage (per function)
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+```
+New-PSCodeHealthTableData -HealthReport $HealthReport
+```
+
+This generates the rows for the tables Best Practices, Maintainability, Failed Tests Details and Test Coverage tables, based on the data in $HealthReport.
+
+## PARAMETERS
+
+### -HealthReport
+To specify the input PSCodeHealth.Overall.HealthReport object containing the data.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+### PSCustomObject
+
+## NOTES
+
+## RELATED LINKS
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,6 +24,7 @@ pages:
     - New-PSCodeHealthComplianceRule: InternalFunctions/New-PSCodeHealthComplianceRule.md
     - New-PSCodeHealthReport: InternalFunctions/New-PSCodeHealthReport.md
     - New-PSCodeHealthHtmlReport: InternalFunctions/New-PSCodeHealthHtmlReport.md
+    - New-PSCodeHealthTableData: InternalFunctions/New-PSCodeHealthTableData.md
     - Set-PSCodeHealthPlaceholdersValue: InternalFunctions/Set-PSCodeHealthPlaceholdersValue.md
     - Get-FunctionDefinition: InternalFunctions/Get-FunctionDefinition.md
     - Get-FunctionLinesOfCode: InternalFunctions/Get-FunctionLinesOfCode.md