dotnet / api-docs-sync

Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.

dotnet/api-docs-sync Issues

PortToTripleSlash might not be working with Microsoft.BCL assemblies
Updated 9 months ago
PortToDocs fails and exits when encountering a malformed xml
Updated 9 months ago
Missing item in dotnet-api-docs removes the existing item in triple slash
Updated a year ago
Some projects can't be ported immediately after building all runtime
Updated a year ago
Convert markdown to normal xml
Updated a year ago1
Remove namespace prefix from docid if it can be resolved
Updated a year ago
If a docs element is empty and can't be backported, don't remove it
Closed a year ago1
Array.Copy Exception when running against System.Formats.Cbor
Closed a year ago3
`<para></para>` elements should be in their own line
Updated a year ago
MsBuild failed processing csproj
Closed a year ago
restore fails with "Unable to find package Microsoft.DotNet.XUnitExtensions"
Closed a year ago1
Simplify Roslyn whitespace handling, use autoformatting
Updated 2 years ago
PortToTripleSlash issues found in unit tests
Closed 2 years ago1
Finding a null followed by a see cref ports them without space
Updated 2 years ago
Automatically add boilerplate summary for auto-added parameterless constructors
Updated 2 years ago
Implement `-PreserveInheritDocTag false` functionality
Updated 2 years ago
Docs Porting Tool improvement
Updated 2 years ago2
Lines containing <param> items do not get new lines properly added
Updated 2 years ago
For types that live in a difference assembly than the one that ships it, make sure the MSBuild task will move them to the appropriate intellisense xml
Updated 2 years ago
Remove space at end of xml elements
Updated 2 years ago
Multiparagraphs with <param>
Updated 2 years ago
Lists should be rendered with <item>
Updated 2 years ago1
Some constructor DocIDs end with #ctor, the tool must convert them to their full method name
Updated 2 years ago1
Pragmas before types and members get dropped when porting docs into triple slash comments
Updated 2 years ago2
cref values including generic types on method parameters get formatted incorrectly
Updated 2 years ago1
Some markdown-formatted remarks are ported into triple slash comments with invalid structure
Updated 2 years ago
Unit tests fail when running against net6.0
Updated 2 years ago
Omit the trailing space in self-closing XML tags
Closed 2 years ago2
Validate against duplicate or otherwise corrupt content
Updated 2 years ago
Bottleneck reading XML element value
Updated 2 years ago
How to deal with cross assembly crefs
Updated 2 years ago
Preserve xml file encoding to prevent non-ascii chars from disappearing
Updated 2 years ago2
Don't indent remarks
Updated 2 years ago1
Type docs applied to all partial classes
Updated 2 years ago
Missing mapping with ToDocs command
Updated 2 years ago
What is ECMAXml?
Closed 2 years ago8
`#ctor` in see crefs needs to be converted to `%23ctor`
Updated 2 years ago
Add exceptions next to each other
Updated 2 years ago
`<p></p>` elements in xml should be converted to `<para></para>`
Updated 2 years ago
xml lists are not getting converted to markdown lists
Updated 2 years ago
Conversion of see crefs to xrefs that contain backtick character is not working
Updated 2 years ago
Some crefs are not converted to xrefs in remarks
Closed 2 years ago3
Bug: When there's a `<seealso cref="..."/>` in remarks triple slash, it does not get ported correctly
Closed 2 years ago
Remove `<inheritdoc />` if the tool ported documentation
Closed 2 years ago2
Bug: Port only `<paramref>` descriptions that are found inside the `<TypeParams>` section
Closed 2 years ago2
File 'Accessibility-version.dll' not found or not a PE file
Updated 3 years ago
Some xrefs for generics produce invalid triple slash comments
Closed 3 years ago1
MSBuild task to compare generated xmls
Updated 3 years ago
Error messages when prerequisite is not built
Updated 3 years ago
Tool is slow
Closed 3 years ago