-
Notifications
You must be signed in to change notification settings - Fork 998
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
API documentation debt - WinForms #4163
Comments
@carlossanlop a number of API that are listed in your report are annotated, and have been since their addition to the codebase. E.g. almost all of the I would think that our xml-docs weren't correctly ingested into the docs repo, which led to this. In the interest of time can you please arrange ingestion of the latest 5.0 build artifacts, so we can concentrate only on the missing docs. |
Thank you for the information, @RussKie . The PRs #3155, #1133 and #3711 merged triple slash comments but haven't yet been ported to dotnet-api-docs. You can use DocsPortingTool to do so, then submit a PR. After that is merged, I will be able to get an updated report with the remaining undoc APIs in WinForms. If you get a chance to do the porting yourself, that would be great. If not, let me know, I could eventually do it myself, but not right away. |
Thanks @carlossanlop , I'll take a look at this and let you know if I get stuck 😄 |
@carlossanlop I've run the following command line:
I'm running into an issue that I'm not sure how to fix through the tool. The error is this:
I checked the code and it looks like a param called |
@AdamYoblick I think this indicates an omission in our code - we missing docs for winforms/src/System.Windows.Forms/src/System/Windows/Forms/TaskDialogButton.cs Lines 67 to 77 in 1d8dba7
|
Ah ok, makes sense. Igor, should I ignore all of these just to get the docs updated, or should I fix them up at the same time?
|
Would be good to fix it - it will both unblock you in this exercise, and we'll get us to the "0" in the docs register :) Holler, if you need a hand. |
Will do Igor. I'll run the docs tool to find all the missing triple slash comments, fix them, and get them into a PR into this repo. Once everyone is happy with that text, I'll re-generate the docs and create a PR into the docs repo. |
@RussKie @JeremyKuhne There are lots of triple slash docs missing from methods in TextRenderer.cs. Most of them are on overloads. I will fix up methods that are missing specific params, but I think we need a separate task to go back and fix large blocks of comments. Jeremy, do you mind taking that task? I think you understand some of these params better than I do. 😄 |
@AdamYoblick sorry for the late reply. I believe @RussKie gave you the answer. The tool is able to help you figure out what the right parameter is, based on the information it finds on both the intellisense xml and the dotnet-api-docs xml. |
@AdamYoblick I added the XML comments for the new overloads- the existing ones all have documentation so I didn't bother adding new XML comments there. For the new overloads (Span) I just copied stuff from docs and tweaked where needed. |
I merged in the PR to fix most of the debt. We still have some debt in the form of suggestions from the docs team, which is tracked with #4194 |
As part of the 6.0 goals, we want to finish documenting APIs that were shipped without triple slash documentation in previous .NET Core versions.
This work item is part of:
We would like the WinForms team to help with this effort by addressing the APIs in the list below, which are missing some or all of their documentation.
Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki
Please add me as a PR reviewer.
Community contributions are welcome.
System.Windows.Forms undocumented APIs
(System.Windows.Forms.DomainUpDown)
(System.Object)
(System.Object)
(System.Int32,System.Object)
(System.Object)
(System.Windows.Forms.ListViewGroupEventArgs)
(System.String,System.Boolean,System.Boolean)
(System.Windows.Forms.TaskDialogButton,System.Windows.Forms.TaskDialogButton)
(System.Windows.Forms.TaskDialogButton,System.Windows.Forms.TaskDialogButton)
(System.Int32,System.Windows.Forms.TaskDialogButton)
(System.Int32,System.Windows.Forms.TaskDialogButton)
(System.String,System.String,System.Boolean,System.Boolean)
(System.String)~System.Windows.Forms.TaskDialogFootnote
(System.Int32,System.Windows.Forms.TaskDialogRadioButton)
(System.Int32,System.Windows.Forms.TaskDialogRadioButton)
(System.String)~System.Windows.Forms.TaskDialogVerificationCheckBox
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Point,System.Drawing.Color)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Point,System.Drawing.Color,System.Drawing.Color)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Point,System.Drawing.Color,
System.Drawing.Color,System.Windows.Forms.TextFormatFlags)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Point,System.Drawing.Color,System.Windows.Forms.TextFormatFlags)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Rectangle,System.Drawing.Color)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Rectangle,System.Drawing.Color,System.Drawing.Color)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Rectangle,System.Drawing.Color,
System.Drawing.Color,System.Windows.Forms.TextFormatFlags)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Rectangle,System.Drawing.Color,System.Windows.Forms.TextFormatFlags)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Size)
(System.Drawing.IDeviceContext,System.ReadOnlySpan{System.Char},
System.Drawing.Font,System.Drawing.Size,System.Windows.Forms.TextFormatFlags)
(System.ReadOnlySpan{System.Char},System.Drawing.Font)
(System.ReadOnlySpan{System.Char},System.Drawing.Font,System.Drawing.Size)
(System.ReadOnlySpan{System.Char},System.Drawing.Font,System.Drawing.Size,
System.Windows.Forms.TextFormatFlags)
(System.Int32)
cc @merriemcgaw
The text was updated successfully, but these errors were encountered: