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
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

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

What's new in v4.5:

  • (Pro) New Template Libraries feature with Export/Import
  • (Pro) New output formats for generated Help files:  Html Help1, MS Help 2, MS Help Viewer, Website
  • (Pro) Custom tag support in Preview Comments and Build Help File
  • (Pro) AllMembers, Methods, Properties, Events, Fields, Operators sections to the generated Help file
  • (Pro) Options Dialog: solution specific settings for Ignore lists, Solution Dictionary and Help File, User Dictionary
  • (Pro) Added Spelling suggestions window to replace SmartTag. The older SmartTag option can be turned back on in the Options
  • Combined arguments of the same exception type into tag text
  • Help file/Preview render correct project language
  • Added syntax highlighting of the blocks in Help File/Preview
  • Moved cache folder to %LocalAppData%
Detailed changes by build:
  • Build 4.5.13099 (Apr 9, 2013)
    • Resolved - (Pro) On some computers required re-activate the product every now and then - this has been resolved now
  • Build 4.5.13017 (Jan 17, 2013) - v4.5 Release 
    • Added: (Pro) New Template Libraries feature with Export/Import
    • Added: (Pro) New output formats for generated Help files:  Html Help1, MS Help 2, MS Help Viewer, Website
    • Added: (Pro) Custom tag support in Preview Comments and Build Help File
    • Added: (Pro) AllMembers, Methods, Properties, Events, Fields, Operators sections to the generated Help file
    • Added: (Pro) Options Dialog: solution specific settings for Ignore lists, Solution Dictionary and Help File
    • Added: (Pro) Options Dialog: option to maintain User Dictionary
    • Added: (Pro) Options Dialog: options to define Help file scope, header and footer
    • Added: (Pro) Spelling suggestions window to replace SmartTag. The older SmartTag option can be turned back on in the Options
    • Added: (Pro) Setup EXE support now command line parameter /extract to extract MSI file into current directory
    • Added: (Pro) Context.DestinationFile property to all rules
    • Added: (Pro) New macro $(OfTheReorderingToLowerCase)
    • Added: (Pro) New property CodeElement.Parent in GhostDoc SDK
    • Added: Combined arguments of the same exception type into tag text
    • Added: Help file/Preview render correct project language
    • Added: Syntax highlighting of the blocks in Help File/Preview
    • Changed: Moved cache folder to %LocalAppData%
    • Fixed: Incorrectly documented inherited constructor issue
    • Fixed: Error loading VS2010 Office projects
    • Fixed: "Error accessing .hhc file" issue
    • Fixed: Inserting comment to method with brackets on the same line
    • Fixed: Incorrect type name in exception tag when the type name contains generic parameters
    • Fixed: Duplicate partial class issue in generated CHM file
    • Fixed: Changed C#-line in documentary to the actual project language
    • Fixed: Freezing when loading references on solution load in Visual Studio
    • Fixed: "GhostDoc.settings is being used by another process" issue
    • Fixed: Removed trailing space in the and elements
    • Fixed: Fixed: Removed trailing space in the and elements

What's new in v4.0:

  • Added Visual Studio 2012 support
  • (Pro) Added Code Spell Checker - merged CodeSpell features into GhostDoc Pro

    • Check Spelling as you type
    • Spell Checking for XML Comments
    • Spell Checking for code elements
    • Spell Checking for strings and comments
    • Spelling SmartTag in the VS Code Editor
    • Added support for OpenOffice dictionaries and multiple languages
    • Ignore files and file extensions
    • Custom User Dictionary
    • Custom Dictionary by Solution
  • Added C/C++ language support
  • Added XML Comment Preview feature - see your comments as they appear in the help file. Enhanced feature in the Pro version.
  • (Pro) Added new Visual Studio toolbar with documenting, comment preview and spell checking commands
  • Added StyleCop compliance - revised all templates to be compliant with StyleCop rules
  • Added Exception Documentation - exceptions raised within a method are documented in the XML Comment
  • (Pro) Add File Header menu and template
  • (Pro) Added IntelliSense to GhostDoc T4 template editor
  • (Pro) Support for comments in T4 templates
  • Fixed Configuration Wizard showing up when GhostDoc configuration is stored in a shared folder or shared between multiple versions of VS
  • Fixed "Configuration file has been modified outside this instance of Visual Studio" when GhostDoc is used with multiple versions of VS
  • Added New Version Notification
  • (Pro) Added Offline Activation for users behind strict firewall
  • Resolved "To generate XML comment you must select a type or a member" issue
  • Fixed number of reported issues
Detailed changes by build:
  • Build 4.0.12289 (Oct 15, 2012)

    • Added - (Pro) Context menu in Spelling Report - now you can correct spelling directly in the report
    • Added - (Pro) <exclude /> will hide members/types in Help file created with Build Help File command
    • Added - (Pro) Copyright (c) within File Header template to comply with StyleCop requirement
    • Resolved - (Pro) GhostDoc uninstalls correctly with VS2012
    • Resolved - (Pro) Build Help File fails on x64 computers
    • Resolved - (Pro) Error building help file when previous version of the help file is open
    • Resolved - (Pro) Issue building help file when parameter in VB.NET does not have return type
    • Resolved - (Pro) Description is no longer empty in enumeration members in the generated help file
    • Resolved - Incorrect exception documenting when exception argument includes string concatenation
    • Resolved - Issue loading references in another AppDomain
    • Resolved - Incorrect handling of code inside of #if statement when conditionals separated by a "," in Project->Properties
    • Resolved - Missing Build Help File command in VS2008
  • Build 4.0.12272 (Sep 28, 2012)

    • Added - ability to select projects for Build Help File menu command
    • Added - (Pro) Property template now documents Nullable properties correctly
    • Added - Exception Documentation now includes exception parameters
    • Resolved - Offline Activation does not display evaluation codes anymore
    • Resolved - Preview Comments and Build Help File are now working for for C++ projects as well (managed code only)
    • Resolved - Importing T4 templates v3 to v4 now works correctly
    • Resolved - Setup is now better at detecting installed Visual Studio version(s)
    • Resolved - ReturnTypeName.FullName macro now returns correct output for the Indexer rule
  • Build 4.0.12256 (Sep 12, 2012) - v4.0 Release 

    • Added - (Pro) VS2012 theme support - Spelling Report tool window
    • Changed - Help file is up to date with the released features
    • Resolved - Document Type and Document File commands now work in C++
    • Resolved - Parser exception related to the await keyword
    • Resolved - Exception documentation gets re-created with empty content while removing existing text
    • Resolved - Custom exception types were not documented
    • Resolved - Generate <returns< text for generic types (e.g. List<string>, CSPResponse<DomainEntity[]> types)
  • Build 4.0.12248 (Sep 4, 2012)

    • Added - Build Help File menu - create your XML Documentation CHM help file with a single click
    • Resolved number of issues
  • Build 4.0.12233 (Aug 20, 2012)

    • Added - Support for <c> and <code> tags in the Comment Preview
    • Added - Syntax highlighting for <code> tags in the Comment Preview
    • Resolved - Comment Preview issue with Enums
    • Resolved - <example> tag rendered incorrectly in Comment Preview
    • Changed - Removed project parsing progress doalog for "Document ..." commands. (Stil required for Comment Preview feature at this point)
    • Resolved - C/C++ support in VS2012 and VS2012 is workign properly now
  • Build 4.0.12209 (Jul 27, 2012) - Beta 2 Stability Update

    • Resolves Visual Studio start up issues
    • Improved Spell Checker and resolved number of issues
    • Resolved - .NET FW 2.0 is no longer required to install GhostDoc
    • Changed - Configuration Wizard was redesigned to match other SubMain products
    • Changed - Options window is now resizable
    • Resolved - Generic classes typed with T are not documented according to StyleCop rules
    • Resolved - Generics generate invalid XML documentation
    • Resolved - Issue with "Rename to..." in Spell Checker when the entered new word with spaces
    • Resolved - GhostDoc Pro cannot import settings from GhostDoc GDP now imports setting but still doesn't convert custom GD rule configuration
    • Resolved - Re-Document This issue
  • Build 4.0.12170 (Jun 18, 2012) - Beta 2 Release

    • Added - (Pro) new Visual Studio toolbar for the Pro with documenting, comment preview and spell checking commands
    • Added - Sync and Refresh toolbar commands to the "Comment Preview"
    • Added - (Pro) Options -> Global Properties - allows to reference custom configured user properties within T4 templates (like in CodeIt.Right)
    • Added - (Pro) "Rename to ..." Spell Checker menu item - enter your own spelling
    • Added - Option to not override existing Remarks
    • Changed - (Pro) Spell Checker parser was rewritten and Spell Checking significantly improved for C# and VB.NET. Original parser is used with C/C++
    • Changed - Replaced most dialog messages with non-blocking Growl style notification
    • Changed - Options dialog was completely redesigned to match other SubMain products
    • Changed - "Document This" shortcut is assigned to Ctrl-Shift-D during setup. The extra initial step of assigning the shortcut was removed. The shortcut still can be re-assigned in Options
    • Changed - (Pro) Esc does not close in T4 editor anymore
    • Changed - Configuration Wizard doesn't show up every time GhostDoc is re-installed unless necessary including minor updates
    • Resolved - Issue showing the "The configuration file of the GhostDoc add-in has been modified outside this instance of Visual Studio." warning when saving Options
    • Resolved - ERROR: invalid expression IndexerParameter.Name.Words.All
  • Build 4.0.12129 (May 8, 2012)

    • Added - Re-Document This menu
    • Resolved - errors when opening files unsupported by GhostDoc Spell Checker
    • Resolved - Duplicate exceptions in XML Comments
  • Build 4.0.12119 (Apr 28, 2012)

    • Resolved - XML documentation does not inherit
    • Added Synchronize button to Preview Comments window toolbar - Sync comment preview content with the current file context
  • Build 4.0.12117 (Apr 26, 2012)

    • Stability improvements for Comment Preview
    • Fixed - Comment Preview would not force refresh after editing comment
  • Build 4.0.12114 (Apr 25, 2012) - Beta 1 Release

    • Mics fixes around the Comment Preview feature
    • Release for private testing
  • Build 4.0.12111 (Apr 22, 2012)

    • Preview Comment now shows non-public members/types as well
    • Preview Comment command now now works outside of a member/type
    • Preview Comment - to avoid security warnings removed language switching JavaScript in the preview tool window and always select current project language code snippet
  • Build 4.0.12110 (Apr 21, 2012)

    • Setup bootstrapper now extracts the setup file into temporary directory not as .TMP but as .MSI to avoid confusion of select anti-virus programs
    • Resolved - Generating documentation for enum values just puts a GUID
    • Resolved - XML comments on methods with generic types
  • Build 4.0.12105 (Apr 14, 2012)

    • (Major) Added C++ language support
    • (Major) First private showing of the XML Comment Preview feature
  • Build 4.0.12097 (Apr 11, 2012)

    • Opened up GhostDoc menu commands for shortcuts assignment
    • Added new command Tools.SubMain.GhostDoc.SmartTagDropMenu
  • Build 4.0.12094 (Apr 3, 2012)

    • Fixed issue documenting WriteOnly properties (VB)
    • GhostDoc is no longer parsing the whole solution before documenting first single method or file
  • Build 4.0.12092 (Apr 2, 2012) - Official Private Alpha Release 

Add Feedback