dotnet / dotnet/api-docs-sync

Type docs applied to all partial classes

未关闭
#91 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
port-to-tripleslash
主要语言
C#
星标
14
派生
21
PR 合并指标
30 天内没有已合并 PR

描述

https://github.com/dotnet/winforms has multiple types that span across multiple files. The tool is currently applying type xmldocs to all partial definitions.
![DocsPortingTool](https://user-images.githubusercontent.com/4403806/132305012-f22cd642-7264-41a0-b2c1-bbdeb2d86b8a.gif)

Instead we should track whether a type has been annotated, and not annotate other partials. When deduping we should perhaps look for the file with the shortest name, e.g. from the following list pick `Application.cs`:
```
src/System.Windows.Forms/src/System/Windows/Forms/Application.ComponentManager.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.MarshallingControl.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ModalApplicationContext.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ParkingWindow.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ThreadContext.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ThreadWindows.cs
```

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。