-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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 #3960
Comments
Redth
added
proposal/open
area-docs
Conceptual docs, API docs, Samples
t/docs 📝
and removed
proposal/open
labels
Jan 5, 2022
This was referenced Aug 30, 2022
Merged
Merged
This was referenced Sep 6, 2022
This was referenced Jan 9, 2023
This was referenced Jan 17, 2023
mattleibow
added
Epic
Groups multiple user stories. Can be grouped under a theme.
and removed
Epic
Groups multiple user stories. Can be grouped under a theme.
labels
Apr 26, 2023
samhouts
added
the
Task
neither bug nor feature but something that needs to be done in support of either
label
Jul 31, 2023
This was referenced Aug 22, 2023
Merged
rmarinho
added a commit
that referenced
this issue
Aug 31, 2023
### Description of Change Moves the external comments to inline, adds missing comments and minor improvements. ### Issues Fixed Related to #3960
This was referenced Aug 31, 2023
Merged
Closing this as many APIs are now documented using inline docs. Any missing ones can be implemented as they appear and do not require a mega issue to track it. |
github-project-automation
bot
moved this from In Progress
to Done
in [ARCHIVED] MAUI Planning
Nov 3, 2023
ghost
locked as resolved and limited conversation to collaborators
Dec 3, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
We currently have some API doc support happening for Inline XML code docs (there is a separate issue for reviewing and documenting requirements around inline docs: #3936 )
We also have an existing set of API Docs for Xamarin.Forms: https://github.com/xamarin/Xamarin.Forms-api-docs
We need to decide on the best way forward to complete the MAUI API docs. There's some questions around the best way to do this. Here's a few questions to provoke some thoughts:
Do we write some automation to bring the existing Forms API docs over and rework namespaces?
If we port existing docs, should we mostly add tags inline in code to point to the old docs?
There's some longer docs that would be messy to inline in source code, should these be split into conceptual docs and shortened/linked to conceptual docs in the API docs?
First pass at porting doc comments from Forms API docs #4099 - Imported old api docs via inline xml doc comment imports
API docs need to be available on the API browserAvailable on https://learn.microsoft.com/en-us/dotnet/api/?view=net-maui-6.0What is the status of the .NET MAUI Docs? #8689
Add missing MAUI API docs #7463
The text was updated successfully, but these errors were encountered: