What is the status of the .NET MAUI Docs?

[gfmoore]

Description

No api

Steps to Reproduce

Looked for an api and can't find one ;)

Version with bug

6.0.400 (current)

Last version that worked well

Unknown/Other

Affected platforms

I was not able test on other platforms

Affected platform versions

All

Did you find any workaround?

Asking lots of questions that could probably be answered with an api document.

Relevant log output

No response

[hartez]

@gfmoore The documentation can be found at https://docs.microsoft.com/en-us/dotnet/maui/

Is there something else you're expecting?

[gfmoore]

Absolutely I expect something else. The documentation is incomplete and does not identify all properties, methods and constructors like an application programming interface should.

Internally you MUST have such a document. Otherwise I can't imagine how your programmers can communicate or write code.

Even if incomplete we need whatever you have, because trying to figure this stuff out is guesswork and simply trial and error, at least in my experience!!!

If I need how to use a particular thing there should be a proper document. I suspect you know this.

As an example I am currently using the MessagingCentre. The documentation talks about "this" but doesn't explain clearly what "this" refers to (I now know). But what methods, parameters etc can be used with this. As an example it was only by trial and error that I worked out you could send objects using this subsystem.

[gfmoore]

Another example is in using the location and map code. That is absolutely incomplete.

[jfversluis]

I'm very sorry but its still not very clear to me what you're exactly looking for. You mention a whole lot of contrete cases without actually refering to points in our Docs of what you are missing.

Are you looking for API Docs like these https://docs.microsoft.com/dotnet/api/Xamarin.Forms?view=xamarin-forms?

Or more conceptual Docs like: https://docs.microsoft.com/dotnet/maui/?

In either case, we are working hard to get both of these up, but unfortunately at the time we aren't quite there yet. If it helps, a lot of the APIs are identical or very similar to how it was in Xamarin.Forms. So if you can't find it for .NET MAUI, it might be worth looking for it in the Xamarin.Forms context to at least be unblocked.

Furthermore I would be very interested in, on a higher level, the things you are missing in the Docs so we can see and prioritize that area.

Thanks!

[ghost]

Hi @gfmoore. We have added the "s/needs-info" label to this issue, which indicates that we have an open question for you before we can take further action. This issue will be closed automatically in 7 days if we do not hear back from you by then - please feel free to re-open it if you come back to this issue after that time.

[hartez]

@gfmoore Unfortunately, the API docs you're looking for aren't available online yet. We're working through some issues with the generation and publishing process. I don't have a time frame yet for when they will be available, but the issue to watch is #3960 - that's where we're tracking this.

[gfmoore]

@gerald Versluis Yep the ones I'm looking for are like
https://docs.microsoft.com/dotnet/api/Xamarin.Forms?view=xamarin-forms?

And yes I have made many comments on the Docs and that team agree that an api is what is needed.

[hujun-open]

+1 for the API doc, it took me 20 minutes search around to find this issue, a complete API doc is mandatory for a GA product in my opinion. I have to read the source code to figure out how to use a certain class/function, it is not productive at all...

[samhouts]

Duplicate of #3960

[jfversluis]

Duplicate of #3960

[gfmoore]

What does that mean "not planned" ? What is not planned?

[hartez]

It's a confusing status that includes "duplicate".

[gfmoore]

Thanks :)

[jfversluis]

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!