SubMain - CodeIt.Right The First Time!


Support Community for SubMain Products
 Home Products Services Download Purchase Support
in Search
Home Forums Blogs Tutorials/CIR Tutorials/GD Downloads
Welcome to SubMain Community Sign in | Join | Help

SubMain Blog

Browse by Tags

All Tags » CodeSpell » GhostDoc » News » Releases   (RSS)
Sorry, but there are no more tags available to filter with.

  • Released: GhostDoc v4.7

    We are happy to introduce the release of GhostDoc v4.7, a version that is greatly influenced by feedback from our users. It extends Visual Studio 2013 support and introduces an Enterprise version, Help Configurations, Help Content Targeting, embedding images into help markup, hyperlinking to base .NET Framework classes, abbreviation expansion, Non-breaking Words list, and much more:

    • Visual Studio 2013 support
    • Introduced GhostDoc Enterprise
    • (Pro) New Help Configuration feature - save custom configured help generation settings and switch between them easily
    • (Pro) 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 layout and template

    For the complete list of v4.7 changes see What's New in GhostDoc and GhostDoc Pro v4.7

    GhostDoc Enterprise

    We have identified a clear need for a new kind of GhostDoc product, specifically suitable for enterprises and customers who need advanced configuration features for the help file output.

    The GhostDoc Enterprise version that we are officially introducing today offers silent deployment options, full customization of the template and layout of the Comment Preview and Help Files. The Enterprise license customers are also eligible for the on-premises Enterprise Licensing Server option.

    For edition comparison please see this page -


    Help Configuration and Help Content Targeting

    The new Help Configuration feature enables you to create ready-to-use help generation profiles. You can easily switch between profiles, depending on what kind of help you are producing. Also you can define attributes with <tags /> in XML Comment and use tag filtering in Help Configuration to target Help content to your specific audience.

    Help Configuration profiles include settings for:

    • Output format
    • Scope
    • Projects to include
    • Header and footer
    • New tag filtering for help content targeting

    How do I try it?

    Download v4.7 at

    Feedback is what empowers us!

    Let us know what you think of the new version here -

  • Released: GhostDoc v4.5

    The .5 release of GhostDoc builds up on the version 4.0 features offering more flexibility for spell checking and help file generation. Most significant changes in v4.5 are:

    • (Pro) New Template Libraries feature with Export/Import
    • (Pro) New output formats for generated Help files
      • Html Help1 (.CHM)
      • MS Help 2 (.HxS)
      • MS Help Viewer aka MS Help 3 (.MSHC)
      • Website (HTML, ASP.NET, PHP)
    • (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
    • (Pro) Custom tag support in Preview Comments and Build Help File
    • (Pro) AllMembers, Methods, Properties, Events, Fields, Operators sections to the generated Help file
    • Combined arguments of the same exception type into tag text
    • Help file/Preview now renders correct project language
    • Added syntax highlighting of the blocks in Help File/Preview
    • Added "Send Feedback..." to enable easy way of providing feedback right from the product menu

    For complete list of v4.5 changes see What's New in GhostDoc and GhostDoc Pro v4.5


    Template Libraries

    While GhostDoc Pro T4 template mechanism provides maximum flexibility how you can tweak and reconfigure your XML Comments and even regular comments, until now there was no easy way to share the set of templates with your team or the community.

    Today we are introducing Template Libraries - you can Export the whole set of your custom templates and distribute it as one file which can be imported. Template Library includes meta-data - the library author, company name and contact information. To access the feature use Options -> Rules -> Export.

    We will be hosting a section on our web site where we publish GhostDoc Pro Template Libraries we release. If you have specific comment formats you want us to release, send your requests in.

    We also want to encourage sharing your templates with the community. Contact us if you have template library you was us to publish.


    New Help File Formats and Options

    When we introduced a simple single click way of generating help file from your project XML comments, we realized that just one CHM format is not enough and we would need to add options to tweak your help file output.

    Today GhostDoc Pro can build into the following help file formats:

    • Html Help1 (.CHM)
    • MS Help 2 (.HxS)
    • MS Help Viewer aka MS Help 3 (.MSHC)
    • Website (HTML, ASP.NET, PHP)

    You also have the following options when building help file with GhostDoc Pro:

    • Select solution projects that you want to be included into the help file
    • Define Header and Footer for the help file pages
    • Decide whether you want to include Private, Internal, Protected members

    How do I try it?

    Download v4.5 at

  • Released: GhostDoc v4.0

    Note to GhostDoc Pro v3 users: Your v3 license won’t work with v4. We will be sending new license codes shortly to those of you with License Protection.

    We are happy to announce the release of GhostDoc v4 and GhostDoc Pro v4 aligned with Visual Studio 2012 release as part of our VS2012 sim-ship commitment!

    Version 4 is a major milestone for us with great new features and rewrites that we have done over the last year. Here are the most significant additions to the GhostDoc feature set:

    • Visual Studio 2012 support
    • (Pro) Source code Spell Checker
    • C/C++ language support
    • XML Comment Preview
    • (Pro) Build Help File
    • StyleCop Compliance – comments generated by GhostDoc are now pass StyleCop validation
    • Exception Documentation - exceptions raised within a method are documented in the XML Comment
    • (Pro) File Header menu and template
    • (Pro) Visual Studio toolbar with commands for documenting, comment preview and spell-checking
    • (Pro) Options -> Global Properties - allows to reference custom configured user properties within T4 templates (CodeIt.Right users will find this very familiar)
    • (Pro) IntelliSense in the T4 template editor
    • Version update notification – you won’t miss new version release ever again!

    For detailed list of v4 changes see What's New in GhostDoc and GhostDoc Pro v4.0

    Spell Checker

    GDv4_SpellChecker_thumb5GhostDoc Pro Spell Checker features:

    • 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
    • Solution wide Spelling Report
    • Check Spelling for
      • Active Document
      • Selected Documents
      • Current Project
      • Entire Solution

    Comment Preview

    Do you want to see how your XML Comment will look like in the help file? Have HTML tags encoded in the XML Comment and want to make sure your HTML is correct? GhostDoc Comment Preview is here to help!


    How do I try it?

    Download v4 at

    Note to Beta testers: We appreciate your contribution to this release and we will be contacting shortly those of you who provided feedback during the alpha/beta testing program.

    Note to GhostDoc Pro v3 users: We have changed licensing schema in v4.0 and your v3.x license codes won't work with v4.0. For users with License Protection we will be sending v4.x license codes shortly. Users without the License Protection have to purchase new version - currently we are not offering upgrade path other than the License Protection program.


This Blog


Home |  Products |  Services |  Download |  Purchase |  Support |  Community |  About Us |