Andreas Grünwald
Andreas Grünwald
Evaluate using [XmlDocMarkdown](https://ejball.com/XmlDocMarkdown) instead of MdDocs to auto-generate the API reference
Separate the API reference data model from the logic to read the model from a set of assemblies
The *Usage* section in the generated command line help uses the application name instead of the assembly/executable name. ### Expected ```txt myapp [--parameter1 ] ``` ### Actual ```txt My Application...
For commandline applications, the exit code is used to communicate errors. Some applications might use more detailed exit codes than 0 for success and 1 for error. If different error...
C# named tuples are currently not supported. For example, the following method definition ```csharp void Method((string name, object value)[] parameters) ``` is shown in the documentation as ```csharp void Method([TupleElementNames(Mono.Cecil.CustomAttributeArgument[])]params...
Visual Studio supports (or at least will support) more tags for formatting text in XML documentation comments (see ): - `c` - `see` tag with `href` - bullet lists -...
Documentation for types includes a list of the type's attributes. This list is not shown for other members that can have attributes: - Constructors - Methods - Method itself -...
A method's return value can have attributes, e.g. ```csharp [return: MyAttribute] public void MyMethod() {} ``` Return value attributes should be listed in the documentation and be included in the...
For a member that uses C# tuples e.g. ```csharp public (string, int) Method() { } ``` the definition included in the documentation uses the generic syntax for `ValueTuple`: ```csharp public...
If a method parameter has a default values, e.g. ```csharp public void MyMethod(string parameter = "value"); ``` the default value is already included in the generated definition of the method....