davidvollmers / doki Goto Github PK

7.0 7.0 0.0 363 KB

A modern .NET Code Documentation Framework

License: MIT License

C# 100.00%

api-documentation cli code code-documentation csharp docs docs-generator documentation documentation-generator dotnet framework tool

doki's Introduction

Watch me do something cool here.

doki's People

Contributors

Stargazers

Watchers

doki's Issues

Links to generic types with non-generic type parameters are broken

See link to IDynamicParentComponent<Listbox<T>> in https://github.com/DavidVollmers/Ignis/blob/features/api-docs/docs/api/Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI.Listbox_1.md

cref to property is producing error

Failed to generate documentation for type Ignis.Components.HeadlessUI.Dialog.
ArgumentOutOfRangeException: Unsupported cref. (Parameter 'cref')
Actual value was P:Ignis.Components.HeadlessUI.Dialog.IsOpen.
  at DocumentationObject BuildCRefDocumentation(string cref, DocumentationObject
     parent) in DocumentationGenerator.Content.cs:340                           
  at XmlDocumentation BuildXmlDocumentation(XPathNavigator navigator,           
     DocumentationObject parent) in DocumentationGenerator.Content.cs:294       
  at IEnumerable<MemberDocumentation> BuildPropertyDocumentation(Type type,     
     DocumentationObject parent, XPathNavigator assemblyXml, ILogger logger) in 
     DocumentationGenerator.Content.cs:220                                      
  at void AddRange(IEnumerable<T> items)                                        
  at T[[]] ToArray<T>(IEnumerable<T> source)                                    
  at async Task<TypeDocumentation> GenerateTypeDocumentationAsync(              
     GeneratorContext<Type> context, CancellationToken cancellationToken) in    
     DocumentationGenerator.cs:373                                              
  at async Task<NamespaceDocumentation> GenerateNamespaceDocumentationAsync(    
     GeneratorContext<string> context, IEnumerable<Type> types,                 
     CancellationToken cancellationToken) in DocumentationGenerator.cs:284