Skip to content
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

macos and ios workloads do not seem to ship API documentation #13614

Closed
sandyarmstrong opened this issue Dec 20, 2021 · 4 comments
Closed

macos and ios workloads do not seem to ship API documentation #13614

sandyarmstrong opened this issue Dec 20, 2021 · 4 comments
Labels
documentation The issue or pull request is about documentation dotnet An issue or pull request related to .NET (6) feature A feature to be implemented
Milestone

Comments

@sandyarmstrong
Copy link
Member

sandyarmstrong commented Dec 20, 2021

  1. Create a .NET 6 macos or ios project.
  2. Open the project in VSMac Preview 4 (which runs on .NET 6, and temporarily cannot load the old monodoc-based help).
  3. Open some source in the editor.
  4. Hover over a type like UIViewController or NSMutableDictionary.

Expected results

Editor tooltip shows descriptive help text for the type.

Actual results

Editor only shows bare type information, no descriptive help text.


I am working on bringing back monodoc support to VSMac, which would allow loading help text from the documentation that ships in /Library/Frameworks/Xamarin.iOS.framework/Versions/Current/share/doc/, but that isn't really correct.

Based on how it seems to work for the rest of the .NET 6 packs, I think workload API docs should be in XML files that ship alongside their DLLs. System.* types get descriptive help text in editor tooltips without issue.

@sandyarmstrong
Copy link
Member Author

Expected

image

Actual

image

@rolfbjarne rolfbjarne added documentation The issue or pull request is about documentation dotnet An issue or pull request related to .NET (6) feature A feature to be implemented labels Dec 20, 2021
@rolfbjarne
Copy link
Member

@jonathanpeppers how does XA handle API documentation in .NET? Do you handle documentation at all?

@rolfbjarne rolfbjarne added this to the .NET 7 milestone Dec 20, 2021
@jonathanpeppers
Copy link
Member

If you look at: https://www.nuget.org/packages/Microsoft.Android.Ref.31/31.0.101-preview.11.117

We still have Mono.Android.xml inside, just like we had for Xamarin.Android.

@rolfbjarne
Copy link
Member

This is partially fixed, in that we know ship the Microsoft.iOS.xml file in the ref pack in the workload.

This means that the IDE should show any documentation in the xml file - the problem is that the file is almost empty.

This last part will be handled in #14372, so I'm considering this issue half done / half duplication of #14372.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue or pull request is about documentation dotnet An issue or pull request related to .NET (6) feature A feature to be implemented
Projects
None yet
Development

No branches or pull requests

3 participants