dotnet/api-docs-sync

Voir sur GitHub

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

Étoiles: 14
Forks: 21
Issues débutants ouvertes: 0
Issues indexées: 51

Langage dominant: C#
Licence: MIT
Dernier push GitHub: 21/9/2024
Dernière indexation: 15/9/2026
Guide de contribution: Aucun guide de contribution
Code de conduite: Code de conduite
Labels débutants: Aucun label débutant indexé
Métriques de merge des PR: Aucune PR mergée en 30 j

Accessible aux débutants Tout

Ouverte Toutes

51 issues ouvertes indexées

When a type is marked `forInternalUseOnly` no docs should be ported Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#182 · Ouverte le 6/10/2025
PortToDocs interprets [x](y) as a hyperlink Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 45/100

dotnet/api-docs-sync#181 · Ouverte le 30/9/2025
Para tags are mangled when explicitly declared in remarks in combination with new-lines Ouverte

Difficulté 4/5 3-5 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#180 · 1 commentaire · Ouverte le 29/9/2025
PortToDocs changing many docs which aren't touched by intellisense input Ouverte

Difficulté 4/5 3-5 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#179 · Ouverte le 26/9/2025
PortToDocs adding inheritdoc for types which aren't publicly documented Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#178 · 1 commentaire · Ouverte le 25/9/2025
PortToDocs tool adding `seealso` elements which duplicate existing `altmember` elements Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#177 · Ouverte le 24/9/2025
PortToDocs tool changing line endings or whitespace and nothing else Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 45/100

dotnet/api-docs-sync#176 · Ouverte le 24/9/2025
Too many \<para> tags added when importing docs from IntelliSense Ouverte

dotnet/api-docs-sync#175 · 1 personne assignée · Ouverte le 17/10/2024
PortToTripleSlash might not be working with Microsoft.BCL assemblies Ouverte

port-to-tripleslash

Difficulté 4/5 3-5 jours Accessibilité débutants 25/100

dotnet/api-docs-sync#167 · Ouverte le 24/8/2023
PortToDocs fails and exits when encountering a malformed xml Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#166 · Ouverte le 23/8/2023
Missing item in dotnet-api-docs removes the existing item in triple slash Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#163 · Ouverte le 19/4/2023
Some projects can't be ported immediately after building all runtime Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 45/100

dotnet/api-docs-sync#162 · Ouverte le 19/4/2023
Convert markdown to normal xml Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#158 · 1 commentaire · Ouverte le 3/2/2023
`<para></para>` elements should be in their own line Ouverte

port-to-tripleslash

dotnet/api-docs-sync#157 · 1 personne assignée · Ouverte le 3/2/2023
Simplify Roslyn whitespace handling, use autoformatting Ouverte

port-to-tripleslash

dotnet/api-docs-sync#148 · 1 personne assignée · Ouverte le 29/11/2022
Finding a null followed by a see cref ports them without space Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#133 · Ouverte le 10/10/2022
Automatically add boilerplate summary for auto-added parameterless constructors Ouverte

port-to-docs

Difficulté 4/5 3-5 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#132 · Ouverte le 23/9/2022
Implement `-PreserveInheritDocTag false` functionality Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 45/100

dotnet/api-docs-sync#129 · Ouverte le 9/9/2022
Conversion of see crefs to xrefs that contain backtick character is not working Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 48/100

dotnet/api-docs-sync#125 · Ouverte le 17/8/2022
xml lists are not getting converted to markdown lists Ouverte

port-to-docs

Difficulté 4/5 3-5 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#118 · Ouverte le 3/6/2022
`<p></p>` elements in xml should be converted to `<para></para>` Ouverte

port-to-docs

Difficulté 2/5 1-3 heures Accessibilité débutants 45/100

dotnet/api-docs-sync#115 · Ouverte le 30/3/2022
Add exceptions next to each other Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 38/100

dotnet/api-docs-sync#114 · Ouverte le 29/3/2022
`#ctor` in see crefs needs to be converted to `%23ctor` Ouverte

port-to-docs

Difficulté 2/5 1-3 heures Accessibilité débutants 45/100

dotnet/api-docs-sync#113 · Ouverte le 29/3/2022
Docs Porting Tool improvement Ouverte

epic

Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100

dotnet/api-docs-sync#104 · 2 commentaires · Ouverte le 20/10/2021
Missing mapping with ToDocs command Ouverte

port-to-docs

Difficulté 4/5 3-5 jours Accessibilité débutants 38/100

dotnet/api-docs-sync#95 · Ouverte le 9/9/2021
Type docs applied to all partial classes Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#91 · Ouverte le 7/9/2021
File 'Accessibility-version.dll' not found or not a PE file Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#88 · Ouverte le 7/9/2021
Don't indent remarks Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#84 · 1 commentaire · Ouverte le 3/9/2021
Preserve xml file encoding to prevent non-ascii chars from disappearing Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#82 · 2 commentaires · Ouverte le 9/8/2021
How to deal with cross assembly crefs Ouverte

port-to-tripleslash

Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100

dotnet/api-docs-sync#81 · Ouverte le 8/8/2021
Bottleneck reading XML element value Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 55/100

dotnet/api-docs-sync#80 · Ouverte le 3/8/2021
Validate against duplicate or otherwise corrupt content Ouverte

port-to-docs

Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100

dotnet/api-docs-sync#79 · Ouverte le 2/8/2021
Unit tests fail when running against net6.0 Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#69 · Ouverte le 1/4/2021
Some markdown-formatted remarks are ported into triple slash comments with invalid structure Ouverte

port-to-tripleslash

Difficulté 4/5 3-5 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#68 · Ouverte le 31/3/2021
cref values including generic types on method parameters get formatted incorrectly Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 45/100

dotnet/api-docs-sync#67 · 1 commentaire · Ouverte le 31/3/2021
Pragmas before types and members get dropped when porting docs into triple slash comments Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#65 · 2 commentaires · Ouverte le 31/3/2021
Some constructor DocIDs end with #ctor, the tool must convert them to their full method name Ouverte

port-to-docs

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#64 · 1 commentaire · Ouverte le 31/3/2021
Lists should be rendered with <item> Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 42/100

dotnet/api-docs-sync#61 · 1 commentaire · Ouverte le 10/3/2021
Multiparagraphs with <param> Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#60 · Ouverte le 10/3/2021
Remove space at end of xml elements Ouverte

port-to-tripleslash

Difficulté 2/5 1-3 heures Accessibilité débutants 58/100

dotnet/api-docs-sync#59 · Ouverte le 10/3/2021
Remove namespace prefix from docid if it can be resolved Ouverte

port-to-tripleslash

dotnet/api-docs-sync#58 · 1 personne assignée · Ouverte le 10/3/2021
Lines containing <param> items do not get new lines properly added Ouverte

port-to-tripleslash

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#56 · 1 réaction · Ouverte le 5/3/2021
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 Ouverte

port-to-tripleslash

Difficulté 4/5 3-5 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#54 · Ouverte le 5/3/2021
MSBuild task to compare generated xmls Ouverte

Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100

dotnet/api-docs-sync#53 · Ouverte le 5/3/2021
Error messages when prerequisite is not built Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#51 · Ouverte le 5/3/2021
Consider word wrapping triple slash comments Ouverte

port-to-tripleslash

dotnet/api-docs-sync#44 · 1 commentaire · 1 réaction · 1 personne assignée · Ouverte le 4/3/2021
Tool fails to run with System.InvalidOperationException: Ouverte

dotnet/api-docs-sync#38 · 7 commentaires · 1 personne assignée · Ouverte le 4/3/2021
Red message saying [Not saved] if user forgot to add -Save true Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 15/100

dotnet/api-docs-sync#16 · Ouverte le 2/9/2020
Detect attribute decorators like Obsolete Ouverte

Difficulté 4/5 3-5 jours Accessibilité débutants 25/100

dotnet/api-docs-sync#14 · Ouverte le 31/3/2020
Add option to force update all comments Ouverte

Difficulté 3/5 1-2 jours Accessibilité débutants 35/100

dotnet/api-docs-sync#6 · 1 réaction · Ouverte le 9/8/2019

dotnet/api-docs-sync

Recevez les nouvelles issues par e-mail