selenium icon indicating copy to clipboard operation
selenium copied to clipboard

[🐛 Bug]: Missing .NET documentation comments

Open BaerMitUmlaut opened this issue 3 years ago • 7 comments

What happened?

The NuGet packages have no documentation comments at all. This affects all versions >= 4.0.0.

  • v4.1.0:
    grafik
  • v3.141.0
    grafik

How can we reproduce the issue?

- Install version 4.1.0 of the Selenium.Support package
- Press F12 on any Selenium type -> no documentation comments
- Downgrade to version 3.141.0
- Press F12 on any Selenium type -> documentation comments 🎉

Relevant log output

-

Operating System

Windows 11

Selenium version

.NET 4.0.0, 4.0.1, 4.1.0

What are the browser(s) and version(s) where you see this issue?

What are the browser driver(s) and version(s) where you see this issue?

ChromeDriver 98.0.4758.8000

Are you using Selenium Grid?

No

BaerMitUmlaut avatar Feb 17 '22 14:02 BaerMitUmlaut

@BaerMitUmlaut, thank you for creating this issue. We will troubleshoot it as soon as we can.


Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

github-actions[bot] avatar Feb 17 '22 14:02 github-actions[bot]

Yes, we haven't had the time too work on that.

Please follow https://github.com/SeleniumHQ/selenium/issues/10126 for updates.

diemol avatar Feb 17 '22 22:02 diemol

#10126 is about the online documentation, which does contain the info I am missing in the screenshot above: https://www.selenium.dev/selenium/docs/api/dotnet/html/M_OpenQA_Selenium_IWebDriver_Manage.htm

This bug is about the documentation delivered by the NuGet package as described in my reproduction steps. I suspect this is a problem within your actual build and not at all related to your online documentation - though I'm not sure how you generate the latter.

BaerMitUmlaut avatar Feb 17 '22 23:02 BaerMitUmlaut

Thank you for clarifying, reopening.

diemol avatar Feb 21 '22 09:02 diemol

PR merged. Thank you.

diemol avatar Apr 21 '22 09:04 diemol

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

github-actions[bot] avatar May 22 '22 00:05 github-actions[bot]

Looks like #10376 didn't fix the issue.

titusfortner avatar Jun 01 '22 20:06 titusfortner

Is this still an issue? I think we merged a couple of PRs for this (PRs I cannot recall now).

diemol avatar May 05 '23 22:05 diemol

This issue is about the comments (like Javadoc) not showing up in the IDE. The fix is to put an xml file somewhere that the packaging can reference it, and the bazel rules do not yet support this (I just double checked with the new dotnet rules owner)

titusfortner avatar May 06 '23 01:05 titusfortner

Fixed by new bazel rules for dotnet.

nvborisenko avatar Oct 03 '23 15:10 nvborisenko