Cleanup for next release.

Author: msorens

CHANGELOG.md

@@ -7,11 +7,26 @@ IMPROVEMENTS:
 BUG FIXES:
 
 
+## 2.0.02 (January 5, 2016)
+
+IMPROVEMENTS:
+  - Report missing cmdlet documentation (proxied by missing Description section).
+  - Add support for build systems/continuous integration with -EnableExit.
+
+
+BUG FIXES:
+  - Corrected link resolver to treat single words as plain text rather than a cmdlet name.
+  - Correct rendering of HTML-special characters in syntax section.
+  - Resynced link to DocTreeGenerator in template to new GitHub location.
+  - Resynced template path after file reorganization.
+
+
+
 ## 2.0.01 (December 21, 2015)
 
 Migrated from http://cleancode.sourceforge.net/
 
-IMPROVEMENTS TO Convert-HelpToHtmlTree
+IMPROVEMENTS:
   - Add support for documenting binary cmdlets (those written in C#)
   - Stylize syntax section (embolden cmdlet name, italicize parameter types)
   - Improve support for text layout:

Convert-HelpToHtmlTree.html

@@ -35,7 +35,7 @@ <h2>SYNOPSIS</h2>
  <div class='PowerShellDoc'>
 <h2>SYNTAX</h2>
 <div>
-<b>Convert-HelpToHtmlTree</b> [-Namespaces] <i>&lt;String[]&gt;</i> [[-TargetDir] <i>&lt;String&gt;</i>] [[-TemplateName] <i>&lt;String&gt;</i>] [[-DocTitle] <i>&lt;String&gt;</i>] [[-Copyright] <i>&lt;String&gt;</i>] [[-RevisionDate] <i>&lt;String&gt;</i>] [-WhatIf] [-Confirm] [<i>&lt;CommonParameters&gt;</i>]
+<b>Convert-HelpToHtmlTree</b> [-Namespaces] <i>&lt;String[]&gt;</i> [[-TargetDir] <i>&lt;String&gt;</i>] [[-TemplateName] <i>&lt;String&gt;</i>] [[-DocTitle] <i>&lt;String&gt;</i>] [[-Copyright] <i>&lt;String&gt;</i>] [[-RevisionDate] <i>&lt;String&gt;</i>] [-EnableExit] [-WhatIf] [-Confirm] [<i>&lt;CommonParameters&gt;</i>]
 <br/>
 <br/></div>
 </div>
@@ -330,6 +330,20 @@ <h2>PARAMETERS</h2>
 <pre>        Default value                </pre>
 <pre>        Accept pipeline input?       false</pre>
 <pre>        Accept wildcard characters?  false</pre>
+<br/>
+    -<strong>EnableExit [&lt;SwitchParameter&gt;]</strong>
+<br/>
+Causes Convert-HelpToHtmlTree to exit with an exit code equal to the number of errors detected.
+Use this to "fail" a build when there are documentation errors.
+Note that this switch causes the invoking shell to exit upon completion of the cmdlet as well!
+Thus, typically you do *not* want to use this switch interactively.
+<br/>
+<br/>
+<pre>        Required?                    false</pre>
+<pre>        Position?                    named</pre>
+<pre>        Default value                False</pre>
+<pre>        Accept pipeline input?       false</pre>
+<pre>        Accept wildcard characters?  false</pre>
 <br/>
     -<strong>WhatIf [&lt;SwitchParameter&gt;]</strong>
 <br/>
@@ -424,7 +438,7 @@ <h2>RELATED LINKS</h2>
 
 
 <p><i>
-This documentation set was created with CleanCode's
+This documentation set was created with 
 <a target="_blank" href="https://github.com/msorens/DocTreeGenerator">DocTreeGenerator</a>.
 </i></p>
 

Source/Convert-HelpToHtmlTree.ps1

@@ -216,6 +216,8 @@ to remove the rest of the revision date phrase.
 .PARAMETER EnableExit
 Causes Convert-HelpToHtmlTree to exit with an exit code equal to the number of errors detected.
 Use this to "fail" a build when there are documentation errors.
+Note that this switch causes the invoking shell to exit upon completion of the cmdlet as well!
+Thus, typically you do *not* want to use this switch interactively.
 
 .INPUTS
 None. You cannot pipe objects to Convert-HelpToHtmlTree.