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

API Documentation #3960

Closed
3 tasks done
Redth opened this issue Jan 5, 2022 · 3 comments
Closed
3 tasks done

API Documentation #3960

Redth opened this issue Jan 5, 2022 · 3 comments
Assignees
Labels
area-docs Conceptual docs, API docs, Samples t/docs 📝 Task neither bug nor feature but something that needs to be done in support of either

Comments

@Redth
Copy link
Member

Redth commented Jan 5, 2022

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:

@Redth Redth added proposal/open area-docs Conceptual docs, API docs, Samples t/docs 📝 and removed proposal/open labels Jan 5, 2022
@Redth Redth moved this to In Progress in [ARCHIVED] MAUI Planning Jan 19, 2022
@hartez
Copy link
Contributor

hartez commented Jan 20, 2022

#4099

@hartez
Copy link
Contributor

hartez commented Jul 14, 2022

Linking issues here so we can update/close when this is done: #8689 #7463

@jfversluis jfversluis removed this from the .NET 7 + Servicing milestone Mar 14, 2023
@mattleibow 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 samhouts added the Task neither bug nor feature but something that needs to be done in support of either label Jul 31, 2023
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
@mattleibow
Copy link
Member

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 github-project-automation bot moved this from In Progress to Done in [ARCHIVED] MAUI Planning Nov 3, 2023
@ghost 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.
Labels
area-docs Conceptual docs, API docs, Samples t/docs 📝 Task neither bug nor feature but something that needs to be done in support of either
Projects
No open projects
Status: Done
Development

No branches or pull requests

5 participants