Follow us on Twitter

Atomineer Pro Documentation Development Summary

This extension began development in 1996 (for Visual C++ 4.0), and has been evolving and improving through constant use by software professionals ever since. More recent developments are listed below...

  Visual Studio Partner  

February 2018

  • Rewrote the Atomineer Spelling extension to resolve issues in Visual Studio 2017. Several recent changes to the Roslyn engine and some other internals of Visual Studio caused problems with the installer and then the spelling highlighting. In addition, with the introduction of the the new 'lightbulb' suggestion system it was necessary to These have been resolved by the new version.
  • Improved handling of enum members in the new declaration parser implementation.
  • Improvements to parsing relating to some old C style syntax cases.
  • Fixed an edge case in handling of templated classes
  • Adjusted 'asSee' generated crefs to use double rather than single quotes.
  • Fixed an issue caused by a software update on our web host, which affected some non-essential featues on the account management web page (such as the last downloaded version not being reported correctly).

January 2018

  • Added handling for C-style structs, unions and enums (as in: struct S function() {}).
  • Documentation Editor Improvements
    • Added a new "Add Entry" button. This allows optional entries (e.g. remarks) to be inserted into the documnetation.
    • You can now navigate to the Next/Previous code element using Alt+Down and Alt+Up. (The Alt key binding is used to avoid clashes with Visual Studio's built in bindings)
    • Next/Previous navigation now places the input focus in the first editable field so that you can now fully document an entire file through the editor without needing to use the mouse.
    • Some other small improvements.
  • Fixed a regression in live typing aids that could extend a comment incorrectly if return was pressed on the final line of a /* */ comment.

December 2017

  • Tested with Visual Studio 2017 (15.5). We recommend users of Atomineer Spelling update to this version of VS 2017 as it resolves issues with the underlining highlights for misspelled words.
  • Added <paramref> support to the documentation editor. New paramrefs can be added from the context menu on any editable field. Existing paramrefs are shown as the parameter name with a highlighted background colour - just click the parameter name to change the reference.
  • Improved parsing of typescript declarations, fixing a case that was handled incorrectly
  • Fixed a rare edge case where Atomineer was not detecting doc comments in single-line /* ... */ comments, causing duplicate comments to be added.

November 2017

  • Added support for C# 7 expression-bodied members in the new method declaration parser, which was unfortunately missed due to some unit tests not being applied to the new code.

October 2017

  • Rewrote the method declaration parser to fully handle inline syntax in C++ and C# declarations, as there were edge cases that the previous parser did not handle correctly.
  • Documentation editor: Improved bullet-list support.
  • Fixed a parsing glitch in Natural Docs exception entries.
  • A large behind the scenes upgrade to our website.

September 2017

  • Documentation editor now has next/previous buttons. These advance the cursor to the next/previous code element and if necessry, executes Add Doc Comment to create a comment, which can then be adjusted in the editor. This allows you to easily step through a file and document it directly in the editor.
  • Documentation editor: Added simple bullet-list support.
  • Documentation editor now automatically snaps its toolbar to the top or left side of the view
  • Documentation editor: some general improvements and under-the-bonnet work to support planned future features.
  • Fixed an issue that could sometimes stop the new template system's EntrySettings being correctly applied. This could cause several symptoms (e.g. optional entries such as seealso being incorrectly deleted from comments while updating them, punctuation being applied to entries that should have had the feature disabled).
  • Added an option for Doxygen-style comments to place in/out specifiers before or after the parameter name.
  • Improved C# 7.0 support for expression-bodied properties and added support for tuple parameters.
  • Fixed a small bug in the preferences app relaing to the 'enforce blanks' settings which worked correctly, but were not being displayed properly when reopening the preferences.
  • Fixed: Word wrapping engine could sometimes break URLs containing minus characters.
  • Improved parsing of C# generics
  • Added support for C++11 brace-initialisation syntax.
  • 'Reformat Doc Comment' will no longer duplicate documentation for parameters.
  • Some more support for projects
  • Small tweaks to the installer to support VS2017 better.

July 2017

  • For Visual Studio 2017/2015, the Documentation Viewer has been upgraded to a Documentation Editor. Edits made in this view will be written back to your source code automatically when the input focus moves out of any entry (i.e. if you switch to editing a different entry, or move the input focus back to your source code, or to another application). The editor supports some basic markup (<b> <i> <code> ) and has been tested primarily with XML documentation; it is being relessed now as a beta feature so that more users can feed back to us if they find any issues with the many variations of documentation styles and formats in the wild, to allow us to develop the feature forwards more quickly. Please note that the editor does not currently support a full set of markup features - markup such as inheritdoc, see, paramref, bullet lists and tables, as well as special doxygen markup (@ commands) will be supported in upcoming releases.
  • Resolved a regression in reformatting of indentation (a poor interaction with specific formatting options), which was introduced by an attempted fix for code block indentation in the 9.34 release. The fix was rolled back and a new fix implemented which does not introduce any side effects.
  • Added a new 'Reformat Doc Comment' command. This reformats a doc comment exactly as Add/Update Doc Comment does, but without adding any new entries to it.
  • The 'convert to entities' option has been expanded, so that < > & can be converted to XML entities &lt; &gt; & or now into more human readable { } + characters.
  • Further small improvements to the C# 7.0 parser.
  • Fixed an edge-case which could adversely affect parsing of attributes embedded within method parameter lists.
  • Fixed a minor parsing issue that was caused by unrecognised macros with 1-character names applied after parameter declarations.
  • Fixed an issue in Doc All in File where some code constructs were not correctly located when intellisense was unavailable, resulting in failure to document some code elements.
  • Fixed a small bug in the preferences that meant generation of 'inheritdoc' rather than 'seealso' was not persisted and had to be set manually.
  • Fixed an issue in the new template system that caused DocXml settings to be applied to Doxygen entries when they used a custom tag name.

May 2017

  • Improvements to the C# 7.0 parser, including a bug fix for misidentified constructors.
  • Fixed cases where exceptions outside the scope of C# 7.0 expression-bodied members were being inadvertently documented.
  • Several improvements to the typescript/javascript parser.
  • Fixed an issue in chained constructors.
  • Fixed a very rare case where documentation background colouring would be missed out for a comment.
  • Improved reformatting of indented example code in a few cases.

April 2017

  • Out-of-band release to fix a small but significant parsing bug introduced in the last release which interfered with processing of member variables.
  • Found and fixed a generic method declaration syntax that was not being correctly handled
  • Added support for C# 7.0 features:
    • Tuple return types
    • Tuple deconstructor member-methods and extension-methods
    • 'ref' method return values
    • Expression bodied members, and exceptions thrown from within them.
    • Auto-properties with default values
  • Improved C# lambda support
  • Improved C# Async support
  • Fixed an indentation issue on duplicated documentation.
  • Optimisations to improve speed of some parsing cases.
  • Added preference for JSDoc (Java, JavaScript, Typescript) documentation format. Although the options are the same as those for Doxygen, this mode now enables the output of JSDoc {type} markup in parameter entries.

February 2017

  • Don't forget to join in with the Visual Studio 2017 launch on March 7!
  • Added support for NaturalDocs format doc comments. Due to the large number of formatting options available, please consider this a public beta at this stage, and let us know if you spot any formatting issues.
  • Updated the core templating system with a new global entry style system so it is no longer necessary to repeat the same settings on each templated entry. This significantly simplifies the templates and ensures consistent formatting across all code element types. The change rationalises the alias mechanism to better support conversion from legacy comment content, and significantly improves the handling of custom entry 'tag' names for built-in entry types. While this is a largely internal change it allows Atomineer to be much more flexible while improving a number of edge cases.
  • Fixed a small but elusive bug in comment updating that occasionally caused entries that should have been deleted to be preserved.
  • Improved extraction of author names from a wider variety of login name styles.
  • Fixed an abbreviation expansion issue when using embedded variables.
  • Fixed a formatting issue when updating a comment containing an <inheritdoc> and overridden doc entries.
  • Live typing aids: Comment auto completion now allows multi-line comments to be missing the closing */
  • Added a new <Suffixes> section in the rules to improve the handling of parameters and members that include custom suffixes like _u32

January 2017

  • New build with additional improvements in the support for Visual Studio 2017 and its new Extension format.
  • Updated copyright dates.

December 2016

  • Added BETA support for Visual Studio 2017 RC. Please let us know if you notice any problems with Atomineer in 2017 RC.
  • Tested with Visual Studio 2017 RC.
  • Improvements to Doc All in Scope, and Doc All progress reporting.
  • Internal improvements to file header comment handling.
  • Fixed 'check for updates', which had been broken by our https website conversion.

Older versions

Details of versions from 2009 to this date are archived here

Copyright © 1996-2018 Atomineer. All Rights Reserved. Any trademarks reproduced in this text are the property of their respective owners - Contact us - Company Info