Xamarin API Docs: Open Sourced and Available Now

Avatar

Larry

Today, we are happy to announce the release of all Xamarin API Documentation as Open Source! API documentation drives the IntelliSense experience while being one of the best ways to help developers achieve their goals.

Xamarin API Docs

Additionally, we have also moved the hosting of the following from their old Xamarin home to docs.microsoft.com:

New Documentation Site

The docs.microsoft.com site delivers the same presentation, search, browsing, localization, and versioning experience used across Microsoft’s .NET platform. Now, you can filter by platform and version, all while getting rapid and accurate search results for namespaces, class names, and member signatures.

Screenshot showing Xamarin.Forms API docs on docs.microsoft.com
Xamarin API Docs now Open Source

GitHub Repos

There are separate Github repos for:

The API documentation is released under Creative Commons Attribution 4.0 License and any related source code under the MIT License. The Github repos are subject to Microsoft’s Open Source Code of Conduct. Xamarin.Android API documentation pages are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Built with Mono

Xamarin API documentation is built with the mono project’s open-source mdoc toolchain. This toolchain converts inline code comments into a dedicated directory of XML documentation files. When you update your source assembly, added/removed classes and members are synced to the documentation repo. With this tool, you can neatly separate engineering and documentation concerns.

Contribute

Help contribute to the Xamarin API docs, or use the mdoc toolchain in your own project today! Edit the XML directly or use the DocWriter tool to avoid the complexity of the XML format.

Avatar
Larry O'Brien

Senior Content Production Manager, Xamarin Docs

Follow Larry   

3 comments

Leave a comment