What's New in GhostDoc v2020

What's new in v2020.x

If are you are a licensed user with a current subscription, you can retrieve your permanent v2020 license code using the MyAccount page.

  • New and improved syntax editor for Rule Template editor and Visual Editor
  • New menu batch action - 'Document Checked Out Files'
  • Documentation Maintenance - now allow analysis on Solution/Project level for 'Missing Documentation', 'Auto-generated Documentation', 'Synchronize with member signature'
  • Documentation Maintenance - improved responsiveness and performance when running the maintenance analysis on a large number of files or projects.
  • New Re-Document action in the Visual Editor
  • Visual Editor improvements - <see> and <seealso> authoring support, key combination Ctrl+Enter now saves and close the window
  • Rule Template editor - easier template customization with improved Intellisense, added Quick Info (on mouseover), Completion List (Ctrl+Space), and Parameter Info
  • Improved and optimized web help TOC generation in non-frame themes
  • (EE) New x64 command-line utility allows producing help documentation for very large solutions
  • Now can document local functions
Detailed changes by build:
  • Build 2020.2.20230 (August 20, 2020) (Maintenance release)
    • Fixed: Unhandled exception when building web help docs using a frameless theme
    • Fixed: Insert button is no longer disabled when inserting the <see> tag in the Comment Editor
    • Fixed: CSS style for section headings in CHM help
    • Fixed: Removed the unwanted leading whitespace when an XML comment is authored in the Comment Editor
    • Fixed: Correctly generating help docs for multiple property definitions in VB
  • Build 2020.2.20200 (July 20, 2020) (Minor feature release)
    • Added: New $(blankLine) macro to insert an empty XML Comment line with the leading /// (''')
    • Added: Now settings Export/Import and Rule Library Save/Load also save/load the rule enabled/disabled state
    • Added: Improved and optimized web help TOC generation in non-frame themes
    • Fixed: Comment Editor will no longer show up when the Re-Document action is selected
    • Fixed: Visual Editor not displaying correctly in the Comment editor under certain circumstances
    • Fixed: Unhandled exception in Community edition when using the Auto-generate option in the Comment Editor
    • Fixed: Build Help Docs failing when run on a non-english system locale
    • Fixed: Issue in Community edition when GhostDoc does retain existing <returns> tag for "void" methods
    • Fixed: Memory leak after using the Comment Editor
    • Fixed: Parsing issues related to the latest C# syntactical enhancements including "pattern match", "foreach" enhancements, "??=" operator, "ref struct", "await using" and "out var"
  • Build 2020.1.20070 (March 10, 2020) (v2020 release)
    • Added: New and improved syntax editor for Rule Template editor and Visual Editor
    • Added: Rule Template editor - easier template customization with improved Intellisense, added Quick Info (on mouse over), Completion List (Ctrl+Space), and Parameter Info
    • Added: Visual Editor - added Re-Document action
    • Added: Visual Editor - key combination Ctrl+Enter now saves and close the window
    • Added: Visual Editor - <see> and <seealso> authoring supported in the Visual Editor
    • Added: Support for <kbd> tag in GhostDoc themes, preview, help documentation, and Visual Editor
    • Added: New 'Document Checked Out Files' menu action
    • Added: Documentation Maintenance - now allow analysis on Solution/Project level for 'Missing Documentation', 'Auto-generated Documentation', 'Synchronize with member signature'
    • Added: Documentation Maintenance - improved responsiveness and performance when running the maintenance analysis on a large number of files or projects.
    • Added: (EE) New x64 command line utility allows producing help documentation for very large solutions
    • Added: Now can document local functions
    • Added: Improved summary/return value/param summary for async methods
    • Added: Arguments property to the Attribute class in T4 rule templates
    • Added: Added GroupSimilarExceptions option to group/ungroup exceptions in Constructor, Indexer, Event, Method, and Property rule templates
    • Fixed: Improved performance when typing /// in the Visual Studio code editor
    • Fixed: Spell Checker - improved spelling popup colors when using the dark theme in VS2019
    • Fixed: Visual Editor - Alt+Enter in the editable field no longer opens the web page properties dialog
    • Fixed: Visual Editor - resolved indent/unindent issues
    • Fixed: Visual Editor - fixed issue related to inserting <see>/<seealso> tag in a Note
    • Fixed: .xaml files are now ignored by the Document Project batch action
    • Fixed: C# parser now handles correctly the static keyword in local function
    • Fixed: Improved C# parser to handle some cases of the nullable reference types
    • Fixed: Fixed async local function declarations in C# parser
    • Fixed: Null-forgiving operator in C# parser
    • Fixed: Issue with the VB interpolated strings format syntax