igloo15/markdowngenerator

Generate markdown from C# binary & xml document for GitHub Wiki.

markdowngenerator's Issues

Nullable multidimensional arrays summary

Multidimensional arrays summary works well with the previous update, but we still managed to find one unhandled type: nullable multidimensional arrays --> the method they are included in parameter don't have summary.

From the previously linked xml file, this is the relevant part:

Create bread crumbs of namespaces on type page

On the type page it should show a breadcrumb style links of the namespaces to quick navigate as well as link to root

Update documentation

The documentation on how to use new code and create themes is nonexistant fix that

Remove legacy Tool and Code

Remove the legacy code from the fork and rehook up the global tool with the new MarkdownApi core

Create nice looking method titles

Currently method titles are just the name and do not include parameters this should be fixed

Paramref in summary

Summaries containing paramref are not handled, and is not displayed in the final documentation.

Relevant part of XML:

Result of documentation:

Show implemented interfaces

Documentation should show inherited abstract and interfaces of a class

ArgumentOutOfRangeException in VSDocParser

Encountered a bug while using version 1.0.1. This only happens in the latest version, older versions are fine, guess it has to domething with the summary fixes. Thanks for your work.

Create nuget package for MarkdownApi Core

The separated core should have a nuget package

Add logging

Logging using Microsoft.Extensions.Logging should be added to core library

Methods that are generic don't differentiate summary text

When a method is generic SomeMethod<T>() it does not differentiate from SomeMethod() when determining summary text.

Fix out parameter

Out parameters don't link correctly

fix global tool not outputing documentation

For some reason global tool when installed from global nuget.org does not generate documentation and can not find any types

Generate Constructors

Document type constructors

Methods containing parameters with more than one generic don't have summaries

When a method contains more than one generic on a parameter it doesn't properly match the summary from the documentation