Xamarin API documentation is now publicly available

Original author: Larry O'Brien
  • Transfer
We are pleased to announce the release of all Xamarin API documentation in Open-Source format! API documentation helps improve interaction with IntelliSense and is one of the best ways to help developers achieve their goals.

Xamarin API Documentation

In addition, we also transferred hosting from the Xamarin website to docs.microsoft.com:

New documentation site

The docs.microsoft.com site provides the same presentation, search, browse, localization, and version control functionality used on the Microsoft .NET platform. Now you can filter by platform and version, while getting fast and accurate search results by namespace, class name, and member signature.

Xamarin API documentation is now open source

GitHub repositories

There are separate Github repositories for:

API documentation is released under the Creative Commons Attribution 4.0 license , and any associated source code is licensed under the MIT license . The repository on Github is subject to the " Microsoft Open Source Code of Conduct ." The Xamarin.Android API documentation pages are modifications based on work created and shared by the Android Open Source Project , and used in accordance with the conditions described in the Creative Commons Attribution 2.5 license .

Built with Mono

The Xamarin API documentation is built using the mono project, an open source mdoc toolkit. This toolkit converts embedded code comments into a dedicated directory of XML documentation files. When updating the original assembly, the added / removed classes and members are synchronized with the documentation repository. With this tool, you can neatly separate engineering and documentary issues.

Make your contribution

Help by contributing to the Xamarin API documentation or using the mdoc toolkit in your own project today! Edit the XML data directly or using the DocWriter tool to avoid possible difficulties with the XML format .

Also popular now: