SubMain - CodeIt.Right The First Time!

/Community

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 » News » GhostDoc   (RSS)

  • GhostDoc Pro Beta brings true Visual Editing to XML Comments

    The latest Beta of GhostDoc introduces a new feature that makes XML documentation authoring a breeze – Visual Edition for XML Comments. The number one challenge authoring XML Comments that we heard from our users has been keeping the valid XML which includes encoding HTML formatting tags, code samples, etc. Many of these don’t even...
  • Released: GhostDoc v5.5

    GhostDoc version 5.5 delivers compatibility with VS2017 RTM as well as a number of fixes:

    • VS2017 RTM support
    • GhostDoc is now also available as VSIX for VS2017
    • Documentation Hints no longer visible in the Debug mode
    • Fixed issue wrapping lines within the <value></value> tag
    • In the Offline Activation Preview - the fields are now auto-selected on focus/click for easy copying
    • GhostDoc is no longer adding extra line when re-documenting header in VB
    • GhostDoc is no longer appending generated XML comments to the existing comment when using auto-generated properties in VB

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v5.4 update

    Version 5.4 of GhostDoc is a maintenance update for the v5.0 users:

    • VS2017 RC integration
    • New menu items - Getting Started Tutorial and Tutorials and Resources
    • (Pro) (Ent) Edit buttons in Options - Solution Ignore List and Options - Spelling Ignore List
    • (Pro) (Ent) Test button in Options - Solution Ignore List
    • (Ent) Now GhostDoc shows error message when Conceptual Content path is invalid in the solution configuration file
    • Fixed PathTooLongException exception when generating preview/build help file for C++ projects
    • (Ent) Updated ClassLibrary1.zip, moved all conceptual content files inside the project in GhostDoc Enterprise\Samples\Conceptual Content\
    • Improved documenting ReadOnly auto-properties in VB
    • Resolved issue re-documenting a type at the top of source code file in VB
    • Resolved issue with generating preview of the <seealso> tag for generics in VB

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    Download the new build at http://submain.com/download/ghostdoc/

  • Survey: What are your biggest code documentation challenges right now?

    We are looking for your input and we're willing to bribe you for answering one very simple question: What are your biggest code documentation challenges right now?

    The survey is super-quick and we're offering a $20 discount code for your time (good with any new SubMain product license purchase) that you will automatically receive once you complete the survey as our thank you.

    Take the Survey

    We'd also appreciate it if you'd help us out by tweeting about this using the link Share on Twitter or otherwise letting folks know we're interested to know their code documentation challenges.

    Thanks for your help!

  • Released: GhostDoc v5.3 update

    Version 5.3 of GhostDoc is a maintenance update for the v5.0 users:

    • Added full support for string interpolation in C# and VB parsers
    • Added support for "arrow functions" in JavaScript parser
    • Fixed "File is not part of a solution" issue when loading projects
    • (Pro) (Ent) Added IsAbstract property to CurrentCodeElement in the T4 templates
    • Improved exception documentation - now the type name in a nameof() parameter is added as part of the generated documentation template
    • (Ent) Fixed iue when using <section> along with <code> elements in an .aml file

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v5.2 update

    Version 5.2 of GhostDoc is a minor feature release for the v5.0 users includes:

    • Support for Visual Studio 2015 Update 3
    • Fixes for the latest ASP.NET Core projects
    • GhostDoc now treats underscore as a delimiter to improve summary generation for underscore delimited identifiers
    • "Use Modern URLs" Help Configuration option for declarative help documentation file naming - namespace-classname-membername.htm
    • Option to turn on/off Documentation Hints during setup
    • (Pro) (Ent)Comment Preview is now rendered using the FlatGray theme
    • Plenty of improvements and bug fixes

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    This version is a required update for Visual Studio 2015 Update 3 users.

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v5.1 update

    Version 5.1 of GhostDoc is a maintenance release for the v5.0 users; includes minor enhancements and number of important bug fixes. Many of the fixes are relevant to the Visual Studio 2015 environment, so while everyone will benefit from this update, it is highly recommended for the Visual Studio 2015 users.

    For the complete list of changes, please see http://support.submain.com/kb/a42/whats-new-in-ghostdoc-v5.aspx

    For overview of the v5.0 features, visit http://submain.com/blog/ReleasedGhostDocV50.aspx

  • Released: GhostDoc v5.0

    Note to GhostDoc Pro v4 users: The v4 licenses won’t work with the v5. We will be sending new license codes shortly to users with License Protection and active Software Assurance subscription. See more information at the bottom of this post.

    Both Pro and Enterprise editions of GhostDoc in version 5 introduce Documentation Quality hints in Visual Studio editor; Documentation Management assistance - find auto-generated comments, edit or remove the bulk created docs; identify and fix comments that are missing, out of sync or can be copied from base class; mark generated XML comments as auto-generated and "to be edited". The v5 also includes multiple Help documentation themes and layouts to choose from.

    The free version of GhostDoc has been re-branded as GhostDoc Community Edition and adds general improvements, limited generation of CHM help documentation as well as the means to find auto-generated comments.

    GD_v5_new_commands

    The new menu commands

    • Documentation Quality Hints in Visual Studio editor
    • Documentation Maintenance - Find auto-generated comments - edit or remove the bulk created docs
    • Documentation Maintenance - Identify and fix comments that are missing, out of sync or can be copied from base class
    • Theme support for generated help documentation and new themes - Flat Gray and Flat Main
    • Official Visual Studio 2015 support
    • Options to add Auto-generated doc and TODO 'Edit' attributes
    • Option to have the default summary text focused and selected when using Document This command - allows to edit/override the summary quickly
    • Exclude from Documentation action – marks a member with a tag to exclude it from the help documentation
    • Hide/Show Comments feature – an easy way to expand/collapse documentation comments to minimize the XML Comments footprint in the Visual Studio code editor
    • New Summary Override table in Options - configure predefined summaries for specific member or type names instead of auto-generated
    • A basic Build Documentation feature is now available in the Community Edition of GhostDoc – while quite limited and watermarked, yet allows to produce simple CHM help documentation for personal use without paying for the commercial version

    For the detailed list of v5.0 changes see What’s New in GhostDoc v5.

    To see new features by product edition see this page - http://submain.com/ghostdoc/editions/


    Documentation Quality Hints

    This new feature provides real-time visual hints in the Visual Studio Editor window to highlight members which have documentation issues that require attention.

    GD_v5_maint_hints

    The following documentation hint actions included with this release make it very easy to maintain the documentation quality:

    GD_v5_maint_hints_list


    Documentation Maintenance

    This feature will help you identify missing documentation, find auto-generated XML comments, maintain your documentation, and keep it up to date. Once these are found, GhostDoc provides the tools to edit or remove the bulk created docs, add missing or fix the dated documentation – one by one or as a batch. You can fine tune the search criteria and use your own template library if yours is different from the built-in.

    • Find auto-generated docs and edit or remove them
    • Find and fix members that are missing documentation
    • Discover members that have parameters, return types, and type parameters out of sync with the existing XML comments and fix the comments
    • Find members that can have XML docs copied from the base class
    • Find documentation that require editing

    GD_v5_maint_autogen

    The Community Edition only allows to find auto-generated documentation and not batch actions – only one action at a time.


    Help Documentation Themes

    In the v5 we are introducing theme support for the generated help documentation and including two new themes, The old help doc view preserved as the Classic theme. You can see the new theme preview here - Flat Gray (default) and Flat Main.

    The Enterprise Edition users can modify the existing themes or create and deploy own help documentation themes – now easier than ever!

    The Community Edition theme selection is limited to one – Classic.

    GD_v5_help_sample


    Auto-generated doc and TODO 'Edit' attributes

    The option to add <autogeneratedoc /> tag to XML comment is intended to provide an explicit flag that the comment has been generated automatically.

    The option to add a TODO comment “TODO Edit XML Comment Template for {member name}” which in turn adds a TODO task into the Visual Studio Task List –> Comments as a reminder for the auto-generated comment requires editing.

    GD_v5_autogen_todo

    Both flags can be used as additional criteria for the documentation quality hints and documentation management “Find auto-generated Documentation” feature. When generating help documentation these flags are also accounted for – the flagged members can be included, ignored or highlighted in the final docs.


    Summary Override

    The Summary Override table allows to configure predefined summaries for specific member or type names to be used instead of the auto-generated. We ship some predefined summary overrides and you are welcome to add your own. If you find a summary override that the GhostDoc user community can benefit of, please submit it to us to be reviewed for the inclusion.

    GD_v5_summary_override

     

    How do I try it?

    Download the v5.0 at http://submain.com/download/ghostdoc/


    Feedback is what keeps us going!

    Let us know what you think of the new version here - http://submain.com/support/feedback/


    Note to the GhostDoc Pro v4 users
    : The v4.x license codes won't work with the v5.0. For users with License Protection and active Software Assurance subscription we will be sending the v5.x license codes shortly. If you need your v5 license sooner, please let us know and we will send one to you. Users without the License Protection or with expired Software Assurance subscription will need to purchase the new version - currently we are not offering upgrade path other than the Software Assurance subscription. For information about the upgrade protection see our Software Assurance and Support - Renewal / Reinstatement Terms

  • Upcoming upgrade protection change for new GhostDoc Pro users

    First, we want to thank all of you for the support and loyalty you have given us over the last few years. We truly have the most amazing and passionate community of developers on the planet, and it makes our job an absolute joy. If you already have a GhostDoc Pro with License Protection, rejoice! The upcoming changes are not going to affect you (and if you were thinking about purchasing additional licenses, now is the time).

    If you don't have GhostDoc Pro, this is your last chance to purchase it with the License Protection and receive free upgrades for the life of the product.

    We are working harder than ever to bring more great features to your favorite plugin. We are super excited about the things we're working on and can't wait to share them with you over the next few months!

    We will be making upgrade protection changes for new GhostDoc Pro users in order to align GhostDoc Pro maintenance and support with all other SubMain's products.

    Starting January 1, 2015, we are retiring the lifetime License Protection option for GhostDoc Pro and replacing it with annual Software Assurance and Support subscription offering.

    If you have been thinking buying new license(s) or adding more licenses, now is the time! Purchase GhostDoc Pro with License Protection by December 31, 2014 and save big on future GhostDoc Pro upgrades!

    Purchase GhostDoc Pro w/ License Protection now!

    What is Software Assurance and Support subscription?

    SubMain customers can purchase 12 months of Software Assurance and Support subscription with the purchase of any new license. Upgrade protection includes access to all major and minor version upgrades for 12 months from the date of purchase at no additional charge.

    Upgrade Protection Timeline 2015

    For example, if a new GhostDoc Pro license is purchased on May 1, 2015, upgrade protection will expire on April 30, 2016. During this time, the customer can download and install any minor version upgrades. In addition, if SubMain issues a major release of GhostDoc Pro during the subscription period, the license can be upgraded to the latest version at no additional charge. With SubMain's Software Assurance, customers will always have access to the latest features and fixes.

    For more information please see Software Assurance and Support - Renewal / Reinstatement

    Again, please note that this new upgrade protection subscription will only affect new license purchases after January 1, 2015. All existing customer licenses with License Protection and those purchased by December 31st, 2014 will be honored and free upgrades will be provided to users with License Protection for the life of the product.

    Thanks again for all of your support. Keep an eye out for more new exciting releases coming very soon!

  • Released: GhostDoc v4.9 Update 1

    GhostDoc v4.9 Update 1 adds support for Shared Projects in all editions and introduces command line version in the Enterprise Edition:

    • (Ent) New feature - 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
    • Improvements and bug fixes

    For detailed list of changes and fixes please see What's New in GhostDoc v4.x

    How do I try it?

    Download v4.9 at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v4.9

    GhostDoc v4.9 is primarily a stability release but it also introduces new Enterprise edition feature:

    • (Ent) New feature - ability to add custom pages to produced help documentation in GhostDoc Enterprise via Conceptual Content concept
    • Improvements and bug fixes

    For detailed list of changes and fixes please see What's New in GhostDoc v4.x

    How do I try it?

    Download v4.9 at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v4.8

    As an active member of the Microsoft Visual Studio Industry Partner (VSIP) program, we again are proud to be VS2013 sim-ship partner and shipping all editions of GhostDoc v4.8 today simultaneously with the release of Visual Studio 2013.

    This release includes official and complete support for Visual Studio 2013 as well as number of improvements and fixes. For details please see What's New in GhostDoc v4.8

    How do I try it?

    Download v4.8 at http://submain.com/download/ghostdoc/

  • 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 - http://submain.com/ghostdoc/editions/

    HelpConfiguration

    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 http://submain.com/download/ghostdoc/

    Feedback is what empowers us!

    Let us know what you think of the new version here - http://submain.com/support/feedback/

  • 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

    gd45_TemplateLibrary

    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.

    gd45_HelpFormats

    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 http://submain.com/download/ghostdoc/

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

    GDv4_CommentPreview_thumb2

    How do I try it?

    Download v4 at http://submain.com/download/ghostdoc/

    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.

More Posts Next page »
    

This Blog

Syndication

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