VSdocman 8.3 released
- 13 Dec 2017 11:33
We are glad to announce that a new version 8.3 of VSdocman has been released. VSdocman is a Visual Studio tool for a quick commenting and automatic generation of technical documentation from your C# and VB .NET source code files. For more information go to VSdocman home page .
This minor update adds F# syntax generation and fixes some problems. You can download it from here.
What's new in VSdocman version 8.3:
- NEW: Added F# declaration of a member in the generated Syntax section. Useful, if your class library is consumed by an F# client.
- CHANGE: Generic types, inherited and extension methods in the Methods list are listed in C# syntax instead of the unfriendly cref syntax. For example, IEnumerable<T> instead of IEnumerable`1.
- CHANGE: Inserted comments that were automatically inherited from referenced projects or assemblies had normalized links with prefixes. For example, <see cref="T:System.String"/>. While this was correct, IntelliSense didn't work for such links in XML comments. Now the prefixes are not inserted, for example, <see cref="System.String"/>.
- CHANGE: A single <para>...</para> block is no longer generated if it's the only paragraph in an XML comment section. This may happen if you had multiple paragraphs and then you deleted all except the one.
- FIX: The full-text search in HTML outputs didn't work if the search term contained a dot, for example "MyNamespace.MyClass".
- FIX: Applying a bulleted or a numbered list in the Exceptions in the WYSIWYG comment editor has caused that entire Exceptions section was lost in then XML comment.
- FIX: When using the comment editor in non-WYSIWYG mode, changes in user-defined fields were not saved to the edited XML comment.
- FIX: The method comment was not inherited from a referenced DLL, if the method had parameters of a generic constructed type, e.g. MyOverridenMethod(Ilist<string> x).
- FIX: Some unwanted methods from referenced DLLs were listed as inherited in the Methods list. For example, static methods were listed, such as Object.ReferenceEquals. Or both shadowed and shadowing methods were listed. For example, if you have your own class that inherits from the Exception class, there were two methods listed - Object.GetType and Exception.GetType. Moreover, these methods could be listed also in other unrelated classes.
- FIX: Some unwanted extension methods were listed in the Extension Methods list. For example, if your class implemented IList<String>, the Average(this IEnumerable<Double>) extension method was incorrectly listed too.
- FIX: Sometimes, not all member descriptions from referenced DLLs were found. For example, System.Linq.Enumerable.Aggregate methods listed in the Extension Methods list had no summary in .NET 4.0 projects.