dotnet/api-docs-sync

View on GitHub

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

Stars: 14
Forks: 21
Open beginner issues: 0
Indexed issues: 51

Dominant language: C#
License: MIT
Last GitHub push: Sep 21, 2024
Latest indexed: Sep 15, 2026
Contributing guide: No contributing guide
Code of conduct: Code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Open All

51 open issues indexed

Output to files Open

dotnet/api-docs-sync#4 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Add option to force update all comments Open

dotnet/api-docs-sync#6 · 0 comments · 1 reaction · 0 assignees · Indexed Sep 15, 2026
Detect attribute decorators like Obsolete Open

dotnet/api-docs-sync#14 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Red message saying [Not saved] if user forgot to add -Save true Open

dotnet/api-docs-sync#16 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Tool fails to run with System.InvalidOperationException: Open

dotnet/api-docs-sync#38 · 7 comments · 0 reactions · 1 assignee · Indexed Sep 15, 2026
Consider word wrapping triple slash comments Open

port-to-tripleslash

dotnet/api-docs-sync#44 · 1 comment · 1 reaction · 1 assignee · Indexed Sep 15, 2026
Error messages when prerequisite is not built Open

dotnet/api-docs-sync#51 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
MSBuild task to compare generated xmls Open

dotnet/api-docs-sync#53 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
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 Open

port-to-tripleslash

dotnet/api-docs-sync#54 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Lines containing <param> items do not get new lines properly added Open

port-to-tripleslash

dotnet/api-docs-sync#56 · 0 comments · 1 reaction · 0 assignees · Indexed Sep 15, 2026
Remove namespace prefix from docid if it can be resolved Open

port-to-tripleslash

dotnet/api-docs-sync#58 · 0 comments · 0 reactions · 1 assignee · Indexed Sep 15, 2026
Remove space at end of xml elements Open

port-to-tripleslash

dotnet/api-docs-sync#59 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Multiparagraphs with <param> Open

port-to-tripleslash

dotnet/api-docs-sync#60 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Lists should be rendered with <item> Open

port-to-tripleslash

dotnet/api-docs-sync#61 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Some constructor DocIDs end with #ctor, the tool must convert them to their full method name Open

port-to-docs

dotnet/api-docs-sync#64 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Pragmas before types and members get dropped when porting docs into triple slash comments Open

port-to-tripleslash

dotnet/api-docs-sync#65 · 2 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
cref values including generic types on method parameters get formatted incorrectly Open

port-to-tripleslash

dotnet/api-docs-sync#67 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Some markdown-formatted remarks are ported into triple slash comments with invalid structure Open

port-to-tripleslash

dotnet/api-docs-sync#68 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Unit tests fail when running against net6.0 Open

port-to-tripleslash

dotnet/api-docs-sync#69 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Validate against duplicate or otherwise corrupt content Open

port-to-docs

dotnet/api-docs-sync#79 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Bottleneck reading XML element value Open

port-to-docs

dotnet/api-docs-sync#80 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
How to deal with cross assembly crefs Open

port-to-tripleslash

dotnet/api-docs-sync#81 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Preserve xml file encoding to prevent non-ascii chars from disappearing Open

port-to-docs

dotnet/api-docs-sync#82 · 2 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Don't indent remarks Open

port-to-docs

dotnet/api-docs-sync#84 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
File 'Accessibility-version.dll' not found or not a PE file Open

dotnet/api-docs-sync#88 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Type docs applied to all partial classes Open

port-to-tripleslash

dotnet/api-docs-sync#91 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Missing mapping with ToDocs command Open

port-to-docs

dotnet/api-docs-sync#95 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Docs Porting Tool improvement Open

epic

dotnet/api-docs-sync#104 · 2 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
`#ctor` in see crefs needs to be converted to `%23ctor` Open

port-to-docs

dotnet/api-docs-sync#113 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Add exceptions next to each other Open

port-to-docs

dotnet/api-docs-sync#114 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
`<p></p>` elements in xml should be converted to `<para></para>` Open

port-to-docs

dotnet/api-docs-sync#115 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
xml lists are not getting converted to markdown lists Open

port-to-docs

dotnet/api-docs-sync#118 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Conversion of see crefs to xrefs that contain backtick character is not working Open

port-to-docs

dotnet/api-docs-sync#125 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Implement `-PreserveInheritDocTag false` functionality Open

port-to-docs

dotnet/api-docs-sync#129 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Automatically add boilerplate summary for auto-added parameterless constructors Open

port-to-docs

dotnet/api-docs-sync#132 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Finding a null followed by a see cref ports them without space Open

port-to-docs

dotnet/api-docs-sync#133 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Simplify Roslyn whitespace handling, use autoformatting Open

port-to-tripleslash

dotnet/api-docs-sync#148 · 0 comments · 0 reactions · 1 assignee · Indexed Sep 15, 2026
`<para></para>` elements should be in their own line Open

port-to-tripleslash

dotnet/api-docs-sync#157 · 0 comments · 0 reactions · 1 assignee · Indexed Sep 15, 2026
Convert markdown to normal xml Open

port-to-tripleslash

dotnet/api-docs-sync#158 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Some projects can't be ported immediately after building all runtime Open

port-to-tripleslash

dotnet/api-docs-sync#162 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Missing item in dotnet-api-docs removes the existing item in triple slash Open

port-to-tripleslash

dotnet/api-docs-sync#163 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
PortToDocs fails and exits when encountering a malformed xml Open

port-to-docs

dotnet/api-docs-sync#166 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
PortToTripleSlash might not be working with Microsoft.BCL assemblies Open

port-to-tripleslash

dotnet/api-docs-sync#167 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Too many \<para> tags added when importing docs from IntelliSense Open

dotnet/api-docs-sync#175 · 0 comments · 0 reactions · 1 assignee · Indexed Sep 15, 2026
PortToDocs tool changing line endings or whitespace and nothing else Open

dotnet/api-docs-sync#176 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
PortToDocs tool adding `seealso` elements which duplicate existing `altmember` elements Open

dotnet/api-docs-sync#177 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
PortToDocs adding inheritdoc for types which aren't publicly documented Open

dotnet/api-docs-sync#178 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
PortToDocs changing many docs which aren't touched by intellisense input Open

dotnet/api-docs-sync#179 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026
Para tags are mangled when explicitly declared in remarks in combination with new-lines Open

dotnet/api-docs-sync#180 · 1 comment · 0 reactions · 0 assignees · Indexed Sep 15, 2026
PortToDocs interprets [x](y) as a hyperlink Open

dotnet/api-docs-sync#181 · 0 comments · 0 reactions · 0 assignees · Indexed Sep 15, 2026

dotnet/api-docs-sync

Get new issues in your inbox