search

barry-jones / live-documenter

.NET documentation generator and live reader. Generate documentation from .NET code and xml comments, fast, quick and easy.
https://livedocumenter.barryjones.me.uk
MIT License
71 stars 4 forks source link

no type detail is shown when return type is generic #36

Open barry-jones opened 5 years ago

barry-jones commented 5 years ago

When a return type is a generic type e.g. List the return type shows simply as List<>.

Perhaps the following would be better:

public List<ContentEntry> GetParents();

Would show in the documentation as:

Returns ContentEntry - Details of return value

barry-jones commented 5 years ago

It is also incorrect then the generic type is defined in the library.

class Issue36_GenericReturnTypes<T>
{
    public Issue36_GenericReturnTypes<string> ReturnInLibraryGenericType() => null;
}

Produces the display name Issue36_GenericReturnTypes<T>. The syntax for the method is displayed correctly.