What's New in GhostDoc v4.x

What's new in v4.9:

  • Option to change location of the user folder to improve performance when Documents folder is mapped to a network/remote drive. Options -> General -> User folder path
  • Option to turn troubleshooting log off and set it Off by default - performance improvement. Options -> General -> Enable Error Log
  • Made setup changes to prevent occasional enterprise setup issues
  • Ability to add custom pages to produced help documentation in GhostDoc Enterprise via Conceptual Content concept
  • GhostDoc Enterprise - Command line version - enables generating help documentation during build process for a specific Help Configuration
  • Support for Visual Studio 2013 Update 3 and Shared Projects/Universal Apps
  • Can now use triple slash (///) shortcut to generate XML Comment template (triple quote (''') in VB) - alternative to Ctrl-Shift-D
  • Beta feature - support for generating XML Comments for JavaScript code
  • Improvements and bug fixes

Detailed changes by build:

  • Build 4.9.15086 (Mar 27, 2015) - Maintenance Release
    • Changed: Now solution settings file .GhostDoc.xml is only saved when the default setting changed (the Free version only)
    • Changed: Renamed SubMain.GhostDoc.Setup.exe to SubMain.GhostDoc.ActionProxy.exe to reflect the purpose of the tool
  • Build 4.9.15071 (Mar 12, 2015) - Maintenance Release
    • Added: Option to change location of the user folder to improve performance when Documents folder is mapped to a network/remote drive. Options -> General -> User folder path
    • Added: Option to turn troubleshooting log off and set it Off by default - performance improvement. Options -> General -> Enable Error Log
    • Changed: Made setup changes to prevent occasional enterprise setup issues
    • Changed: Removed the Configuration file path Options, still available to modify directly in the settings file.
    • Fixed: (Ent) Addressed some MAML elements rendered incorrect help documentation output. Fixed file main_conceptual.xsl
    • Fixed: Issues activating unicode licenses
    • Fixed: Warning/error growl messages no longer grab focus
    • Fixed: Resolved issue of duplicate attribute decorators appearing in the generated help documentation
  • Build 4.9.14358 (Dec 24, 2014) - Minor Release
    • Added: Solution Options -> Ignore files by pattern with '*.min.js' and 'jquery*.js' included as default
    • Added: Option to turn Spell Checker on/off during setup
    • Added: Support for SQL Server projects
    • Added: New properties to the Context helper class - Context.AssemblyVersion, Context.AssemblyCopyright and Context.AssemblyCompany to be used in the T4 templates
    • Changed: Setup performance improvement - no longer executes 'devenv /setup' command when installing/uninstalling GhostDoc
    • Fixed: Addressed performance issues introduced in build 14262
    • Fixed: Addressed Visual Studio stability issue
    • Fixed: Performance lag when adding file or reference to solution
    • Fixed: Improved performance when documenting overridden member
    • Fixed: Triple slash (///) shortcut now generates XML Comment template in C++
    • Fixed: Resolved issue of occasionally not adding file header while cursor is above namespace
    • Fixed: Repositioned spelling suggestions popup to avoid covering the misspelled word
  • Build 4.9.14262 (Sep 19, 2014) - Feature Release
    • Added: VS2013 Update 3 support
    • Added: Build Help File - New 'Inherited from References' option in the Help Configuration 'Scopes to include' allows to hide on the class documentation page those members that are inherited from 3rd party references
    • Added: Triple slash (///) shortcut now generates XML Comment template (triple quote (''') in VB) - alternative to Ctrl-Shift-D. Can turn this off in Options -> General.
    • Added: Beta feature - support for documenting JavaScript code. Help documentation for JavaScript docs is not implemented in this build
    • Changed: Improved cursor placement requirements to generate comment template - now cursor can be placed anywhere within the method
    • Fixed: Issue when coping documentation from interface
    • Fixed: Issue with Visual Studio hanging up when loading C++ project in VS2013 Update 3
    • Fixed: Issue with C++ properties not showing up in generated help documentation
    • Fixed: Visual Studio crash when pressing Ctrl-Tab with spelling tooltip shown
    • Fixed: Issue with relative path for output folder in the Build Help File dialog
    • Fixed: Issue in web site format of help documentation - backslash in PHP files instead of slash
    • Fixed: Issues with Shared/Universal App projects
    • Fixed: Issue with C# generic substitutes
  • Build 4.9.14147 (May 27, 2014) - Feature Release
    • Added: (Ent) Command line version - enables generating help documentation during build process for a specific Help Configuration
    • Added: Support for Visual Studio 2013 Update 2 Shared Projects/Universal Apps
    • Changed: GhostDoc is no longer using Visual Studio Add-In API
    • Fixed: Issue when building help file in VS2012 (.hhc file not found)
    • Fixed: Spell checker causing Visual Studio freeze
    • Fixed: Resolved indentation issues when formatting inherited XML Comments
    • Fixed: No longer dropping <exception> tags in the documentation of a derived member
  • Build 4.9.14093 (Apr 3, 2014) - Bugfix Release
    • Fixed: Incorrect sort order of in the generated documentation in VS2010
    • Fixed: When GhostDoc unloaded with the Unload menu it did not unload the spell checker
    • Fixed: Unhandled exceptions related to loading references
    • Fixed: Adding a misspelled word to Solution/User dictionary does not immediately remove all other misspelling occurrences
    • Fixed: Issue with generating <example> tag
  • Build 4.9.14064 (Mar 5, 2014) - v4.9 Release
    • Added: (Ent) Ability to add custom pages to generated help documentation via Conceptual Content concept
    • Added: (Pro) Now reuse existing <summary> and <remarks> when available while generating File Header
    • Added: (Pro) (Ent) Preview button in Offline Activation allows to see content of the activation email request (to be sent from another machine)
    • Added: (Pro) Now can set a delay value to start spell checking document after it's been opened
    • Fixed: (Pro) When solution has multiple projects with the same name they will be handled correctly now
    • Fixed: (Pro) Issue when user image folder files are read-only files
    • Fixed: Issue incorrectly documenting operators
    • Fixed: Issue with nested generic parameters to a function not properly shown in the produced help documentation TOC
    • Fixed: Issue with interface method type parameters rendering incorrectly in help documentation
    • Fixed: Now escaping escaping '<' and '>' characters in crefs
    • Fixed: In the <returns> element, local generic type parameters are now referenced by name
    • Fixed: Now multiple type parameters in return type are separated by comma
    • Fixed: (Pro) In help file braces in generic types were incorrectly rendered as angle brackets
    • Fixed: Function prototype now does not contain the additional part denoting the number of generic parameters
    • Fixed: (Pro) Type parameter constraints are now visible in the produced help documentation
    • Fixed: Issues with <returns> when method returns an array
    • Fixed: (Pro) Context.AssemblyName was incorrectly returning project name
    • Fixed: Issue with inherited exception constructor documentation
    • Fixed: (Pro) Issue with Re-Document This duplicating summary text

What's new in v4.8:

  • Official Visual Studio 2013 support
  • Minor enhancements and bug fixes

Detailed changes by build:

  • Build 4.8.13316 (Nov 12, 2013) - v4.8 Release
    • Added: Official Visual Studio 2013 support
    • Added: (Ent) /localService command line switch to Registration utility for license activation using Enterprise Licensing Server
    • Fixed: (Pro) MS Help Viewer documentation is now generated correctly
    • Fixed: (Pro)Build Help File now works when solution contains two or more projects with the same name
    • Fixed: (Pro) Issue determining code sample language in mixed language web-site project
    • Fixed: (Pro) Issue generating incorrect documentation for "On" methods
    • Fixed: (Pro) Spacing issue when inserting file header

Also see What's New in GhostDoc v4.7

Add Feedback