What's New in GhostDoc v2021

What's new in v2021.x

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

  • Dark Theme for help documentation
  • Support for TypeScript language and TypeScript projects
    • Currently supported in
      • Document This
      • Re-document This
      • Document Type
      • Document File
      • Document Project
    • Not supported yet in
      • Document File Header
      • Document Checked Out Files
      • Exclude This from Documentation
      • Visual Comment Editor
      • Generate Help Documentation
      • Preview Comment
      • Documentation Maintenance
  • Added: Support for C# 9 syntax - Records, Nullable reference types, Init Only Setters, Extending partial methods, Pattern-matching changes (except Variable definitions and definite assignment), Top-level statements, Lambda discard parameters, Static anonymous functions, Attributes on local functions, Native-sized integers, Unconstrained type parameter annotations
  • Backup error-recovery compliant parsing engine that improves the quality of comment template generation in Document This/Type/File/Project, Comment Preview, and Build Help Documentation
  • Support the <inheritdoc /> tag at the class level
  • cref attribute support in the <inheritdoc /> tag
  • Memory optimization - the new DisableUndoAndSaveDocumentProject reduces VS memory use by saving all modified files when performing Document Project batch action
  • Display subscription information in the About window
  • No longer distributing the legacy frame-based themes with GhostDoc - will be available for download at our support site
Detailed changes by build:
  • Build 2021.2.21150 (May 30, 2021) (Maintenance release)
    • Added: New UseCurlyForGenerics solution property to switch between curly braces ({}) and "&lt;/&gt;" for generics
    • Added: New DisableUndoAndSaveDocumentProject setting to save all modified files as the Document Project action progresses. Saves VS memory and performance on large projects.
    • Added: New ClassicLookCHM solution property to switch between classic and modern icon sets in generated CHM docs
    • Fixed: Web themes would not switch under certain circumstances
    • Fixed: Issue when generating help preview and help docs with a note tag specified of a specific type
    • Fixed: Generated summary starts with a lower case character for async methods
  • Build 2021.2.21090 (March 31, 2021) (Minor feature release)
    • Added: Support for C# 9 syntax - Records, Nullable reference types, Init Only Setters, Extending partial methods, Pattern-matching changes (except Variable definitions and definite assignment), Top-level statements, Lambda discard parameters, Static anonymous functions, Attributes on local functions, Native-sized integers, Unconstrained type parameter annotations
    • Added: MSI setup is showing clear instructions to use the VSIX installer for VS2019 instead of the MSI/EXE
    • Added: Preview toolwindow supports dark theme
    • Added: Support the <inheritdoc /> tag at the class level
    • Added: cref attribute support in the <inheritdoc /> tag
    • Added: Visual Editor - show a warning when Esc pressed with unsaved edits in the example and note dialogs
    • Added: Memory optimization - the new DisableUndoAndSaveDocumentProject reduces VS memory use by saving all modified files when performing Document Project batch action
    • Added: Display a progress dialog when documenting a C++ type/file
    • Fixed: Now adding <param> and <typeparam> tags from the base member when use <inheritdoc /> tag
    • Fixed: Issue documenting a member with identical <exception> tags producing a duplicate cref record
    • Fixed: Issue with the <example> tags that includes <code> blocks with comments inside
    • Fixed: FlatDark.theme now shows vertical scrollbar
    • Fixed: C++ reference (ampersand) is now escaped in the generated XML Comment
  • Build 2021.1.20350 (December 15, 2020) (v2021 release)
    • Added: Dark Theme for help documentation
    • Added: Support for TypeScript language and TypeScript projects
      • Currently supported in
        • Document This
        • Re-document This
        • Document Type
        • Document File
        • Document Project
      • Not supported yet in
        • Document File Header
        • Document Checked Out Files
        • Exclude This from Documentation
        • Visual Comment Editor
        • Generate Help Documentation
        • Preview Comment
        • Documentation Maintenance
    • Added: Backup error-recovery compliant parsing engine that improves the quality of comment template generation in Document This/Type/File/Project, Comment Preview and Build Help Documentation
    • Added: Display subscription information in the About window
    • Changed: No longer distributing the legacy frame-based themes with GhostDoc - will be available for download at our support site
    • Fixed: Issue with TOC in web-based help docs with more than one namespace in it
    • Fixed: Resolved Solution Options -> General options being overwritten by the Settings Override values