Skip to content

Releases: msorens/DocTreeGenerator

2.0.09

05 Aug 03:23
Compare
Choose a tag to compare
  • Added new templates (one for testing and debugging; one for a clean modern design), thanks to ebekker!
  • Improved user experience for missing namespaces, modules, and functions.
  • Several minor bug fixes.

2.0.08

10 Jun 16:24
Compare
Choose a tag to compare

Bookkeeping to provide support for release to PSGallery (so the module may be found and installed with PowerShellGet).

2.0.07

24 Dec 01:20
Compare
Choose a tag to compare

IMPROVEMENTS:

  • Added Publish-ModuleDocumentationTree for more easily automating
    documentation generation for several modules under a single namespace.
  • Added Copy-Module cmdlet to support above.

2.0.06

15 Jun 03:14
Compare
Choose a tag to compare

IMPROVEMENTS:

  • Report more specific errors when no namespaces are found.
  • Added -SourceDir parameter to allow modules located in an arbitrary
    directory. #4

BUG FIXES:

  • If custom function listed as a related link was not found, it previously
    generated an invalid URL on the hyperlink for it.
    Changed to just emit the custom function name as plain text.

2.0.05

22 Apr 16:20
Compare
Choose a tag to compare

IMPROVEMENTS:

  • Report more specific errors when problems with an overview file are encountered.
  • Added template and script for regenerating self-documentation (i.e. DocTreeGenerator itself).

BUG FIXES:

  • Overview files were not returning valid results with a DocType definition (DTD) present. #3

2.0.04

02 Mar 15:04
Compare
Choose a tag to compare

IMPROVEMENTS:

  • In conjunction with fixing multi-line code examples (below),
    changed list items (beginning with plus, minus, asterisk) to still
    emit a <br> before the line but removed emitting one after the line.
  • Also for code examples, added emitting a <br> before a canonical
    PowerShell prompt (PS>).

BUG FIXES:

  • Module properties used in template might appear with multiple values
    if module being documented was already loaded in the PowerShell host.
  • Code examples with more than one line of code had several HTML generation
    issues.

2.0.03

01 Feb 01:58
Compare
Choose a tag to compare

ADMINISTRATIVE:

  • Corrected encoding for manifest (changed from Unicode to ASCII).
  • Removed stray formatting character from read me interfering with a URL.
  • Updated version in the manifest to reflect the release number.

BUG FIXES:

  • Check for missing module description was failing intermittently.

2.0.02

05 Jan 21:28
Compare
Choose a tag to compare

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

21 Dec 23:21
Compare
Choose a tag to compare

Migrated from http://cleancode.sourceforge.net/

IMPROVEMENTS TO Convert-HelpToHtmlTree

  • Add support for documenting binary cmdlets (those written in C#)
  • Stylize syntax section (embolden cmdlet name, italicize parameter types)
  • Improve support for text layout:

    recognize lists and add line breaks
    recognize headers and add line breaks and apply style tag.
    recognize code segments and apply style tag.
    flow and wrap body text for description and for parameters.

  • Add unit tests.
  • Update license.