What's New in GhostDoc and GhostDoc Pro v4.7

What's new in v4.7:

  • Visual Studio 2013 support
  • Introduced GhostDoc Enterprise
  • (Pro) New Help Configuration feature - save custom configured help generation settings and switch between them easily
  • (Pro) New Help Content Targeting - ability to create a (partial) 'filtered' help file based on attributes by using <tags/> in XML Comment and tag filtering in Help Configuration. If you need to have different help content for public API users, testers, internal documentation, etc, you can do that now!
  • New Abbreviations dictionary enables expanding abbreviations to full words (for example, 'args' -> 'arguments')
  • New Non-breaking Words list to preserve splitting when comment template is generated (for example, 'CheckBox' or 'ListView')
  • (Pro) Embed/reference images into the Help markup
  • (Pro) Option to skip documenting private/internal/protected members with Document File/Type batch commands
  • (Pro) .NET Framework classes are now hyperlinked to corresponding Microsoft reference page for additional information
  • (Ent) Customize Comment Preview
  • (Ent) Customize help template

Detailed changes by build:

  • Build 4.7.13254 (Sep 12, 2013) - Stability Update
    • Fixed: (Pro) "Tagged with" now works correctly when it is the only Scope selection on the Help Configuration screen
    • Fixed: Issue with abbreviations expanding incorrectly
    • Fixed: Issue with Visual Studio crashing when GhostDoc settings file is not well-formed (corrupted)
    • Fixed: MSDN link for enumeration member
    • Fixed: OutOfMemoryException related to parsing error
  • Build 4.7.13226 (Aug 14, 2013) - v4.7 Release
    • Added: Visual Studio 2013 support
    • Added: Introduced GhostDoc Enterprise
    • Added: (Pro) Build Help - introduced notion of Help Configuration - save custom configured help generation settings and switch between them easily
    • Added: (Pro) Build Help - Help Content Targeting - ability to create a (partial) 'filtered' help file based on attributes by using <tags/> in XML Comment and tag filtering in Help Configuration. If you need to have different help content for public API users, testers, internal documentation, etc, you can do that now!
    • Added: Abbreviations dictionary enables expanding abbreviations to full words (for example, 'args' -> 'arguments')
    • Added: Non-breaking Words list to preserve splitting when comment template is generated (for example, 'CheckBox' or 'ListView')
    • Added: (Pro) Option to skip documenting private/internal/protected members with Document File/Type batch commands
    • Added: (Pro) You now can embed/reference images into the Help markup
    • Added: (Pro) Build Help - Visual Studio toolbar now has Build Help menu in the dropdown (this is not available for IDE prior to VS2010)
    • Added: (Pro) Build Help - .NET Framework classes are now hyperlinked to corresponding Microsoft reference page for additional information
    • Added: (Pro) Build Help - namespace documentation support in Comment Preview and Build Help
    • Added: (Ent) Ability to customize Comment Preview
    • Added: (Ent) Ability to customize Help template
    • Added: (Pro) Build Help - option to include inherited members into the generated help, in addition to those explicitly declared within the type (currently C# and VB.NET only)
    • Added: (Pro) Build Help - Help Configuration "private", "protected" and "internal" scope are now Off by default
    • Added: (Ent) Build Help - option to hide "Generated by GhostDoc" footer
    • Added: (Ent) New SubMain.GhostDoc.Registration utility for command line activation of Enterprise licenses
    • Added: Default rule for the Main method
    • Added: Options to Backup Configuration and Backup Template Library links within the Upgrade Wizard dialog
    • Added: "Never check for updates" checkbox in the AutoUpdate dialog
    • Changed: (Pro) Changed True/False in T4 templates to $(True)/$(False)
    • Changed: (Pro) Spell Checker - user/solution dictionaries are now case insensitive
    • Changed: (Pro) Build Help - Code reference attributes (<see cref="{TypeOrMember}"/>) now correctly resolve within the solution (was only within current project in v4.5)
    • Fixed: Spelling tooltip grabs focus in the VS Editor
    • Fixed: Context.AssemblyName now works correctly in all T4 templates
    • Fixed: Scaling for DPI over 120
    • Fixed: Macros changes in Options dialog not saved
    • Fixed: Issue with compiler directives
    • Fixed: "Async method summary should end with: as an asynchronous operation."
    • Fixed: Generated web site help right-hand pane content was not visible in IE10+
    • Fixed: GhostDoc incorrectly determined Boolean (in C#) return type in rules
    • Fixed: Unloading References is slow when GhostDoc installed
    • Fixed: Unable to retrieve documentation from nested Interfaces
    • Fixed: Issue with documenting methods that contain anonymous methods
    • Fixed: Incorrect path to the html files in SearchHelp.aspx (web site help)
    • Fixed: Issue building help for C++/CX project on Windows 8
    • Fixed: public const int documented as public static int
    • Fixed: The new custom rule window closes when modifying filter parameters
    • Fixed: Duplicate partial types issue in help file
    • Fixed: "Skip This Version" did not work properly
    • Fixed: Issue when documenting member with existing exceptions in the documentation
    • Fixed: "Change the parameter type" dialog does not work
    • Fixed: GhostDoc needs to warn when building CHM or web site help without .NET Framework 4.0 installed

Also see What's New in GhostDoc and GhostDoc Pro v4.5

Add Feedback