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

Add missing MAUI API docs #7463

Closed
Eagle3386 opened this issue May 25, 2022 · 8 comments
Closed

Add missing MAUI API docs #7463

Eagle3386 opened this issue May 25, 2022 · 8 comments
Labels
area-docs Conceptual docs, API docs, Samples p/2 Work that is important, but is currently not scheduled for release platform/android 🤖 platform/iOS 🍎 platform/macOS 🍏 macOS / Mac Catalyst platform/windows 🪟 s/verified Verified / Reproducible Issue ready for Engineering Triage t/bug Something isn't working t/docs 📝

Comments

@Eagle3386
Copy link

Description

Plenty of MAUI's API documentation is missing within VS IntelliSense, e. g. after typing

MauiApp.CreateBuilder().

none of the MauiAppBuilder extensions, e. g. UseMauiApp<T>() or even ConfigureFonts(), provide any information besides their method signature due to missing XML docs within their source code:

public static partial class AppHostBuilderExtensions
{
public static MauiAppBuilder UseMauiApp<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TApp>(this MauiAppBuilder builder)
where TApp : class, IApplication
{

}
public static MauiAppBuilder ConfigureFonts(this MauiAppBuilder builder, Action<IFontCollection>? configureDelegate)
{
builder.Services.TryAddSingleton<IEmbeddedFontLoader>(svc => new EmbeddedFontLoader(svc));

Steps to Reproduce

  1. Create a File > New .NET MAUI App
  2. Go to CreateMauiApp() inside MauiProgram.cs.
  3. At the line with MauiApp.CreateBuilder(), type a . after the closing parenthesis.

Version with bug

Release Candidate 3 (current)

Last version that worked well

Unknown/Other

Affected platforms

iOS, Android, Windows, macOS, Other (Tizen, Linux, etc. not supported by Microsoft directly)

Affected platform versions

Any supported platform version up to now

Did you find any workaround?

Nope. 😢

Relevant log output

None available. 😢
@Eagle3386 Eagle3386 added s/needs-verification Indicates that this issue needs initial verification before further triage will happen t/bug Something isn't working labels May 25, 2022
@janseris
Copy link

janseris commented May 25, 2022

Good point. A lot of MAUI API misses documentation. For example MAUI Graphics code as well. I had to look up the source code on GitHub to be able to find out how it works for every function I use. (IImage API) - I checked right now on GA - the docs are still not there.

Edit: I'm always on the latest MAUI

Microsoft.Maui.Storage:
image

@Eilon Eilon added the area-docs Conceptual docs, API docs, Samples label May 25, 2022
@Eilon
Copy link
Member

Eilon commented May 25, 2022

BTW in .NET MAUI 6 GA (that we released this week) you should see a TON more documentation for APIs. It's certainly not complete, but prior to that, there were ZERO docs visible for the main MAUI APIs.

@Eagle3386
Copy link
Author

@Eilon Neither is the case - I had some (very few, but still) prior to GA release, yet still after its release essential docs (e. g. both methods in my OP are part of any new MAUI project) remain missing.

@Eilon
Copy link
Member

Eilon commented May 26, 2022

@Eilon Neither is the case - I had some (very few, but still) prior to GA release, yet still after its release essential docs (e. g. both methods in my OP are part of any new MAUI project) remain missing.

Understood, and I agree that many API docs are still missing. My comment was that prior to GA there were essentially ZERO API docs visible in VS, and starting with GA (released this week) there are many thousands of API docs available. Unfortunately, the APIs you mentioned are still not available.

@VincentBu
Copy link

repro with vs main build (32605.41.main)

@VincentBu VincentBu added s/verified Verified / Reproducible Issue ready for Engineering Triage and removed s/needs-verification Indicates that this issue needs initial verification before further triage will happen labels Jun 6, 2022
@samhouts samhouts added the p/2 Work that is important, but is currently not scheduled for release label Jul 7, 2022
@hartez hartez mentioned this issue Jul 14, 2022
3 tasks
@samhouts
Copy link
Member

Duplicate of #3960

@samhouts samhouts marked this as a duplicate of #3960 Aug 22, 2022
@jfversluis
Copy link
Member

Duplicate of #3960

@jfversluis jfversluis closed this as not planned Won't fix, can't repro, duplicate, stale Aug 25, 2022
@ghost ghost locked as resolved and limited conversation to collaborators Sep 24, 2022
@jfversluis
Copy link
Member

For anyone stumbling on this, the API docs are now published here: https://learn.microsoft.com/dotnet/api/?view=net-maui-6.0

While all the APIs are there, not all have a complete/accurate description yet, we're working hard on making that happen. Of course you are welcome to contribute to that. Thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-docs Conceptual docs, API docs, Samples p/2 Work that is important, but is currently not scheduled for release platform/android 🤖 platform/iOS 🍎 platform/macOS 🍏 macOS / Mac Catalyst platform/windows 🪟 s/verified Verified / Reproducible Issue ready for Engineering Triage t/bug Something isn't working t/docs 📝
Projects
None yet
Development

No branches or pull requests

7 participants