Skip to content
This repository was archived by the owner on May 29, 2024. It is now read-only.

xamarin/android-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a993a89 · May 29, 2024
Dec 2, 2022
Jan 24, 2024
Nov 17, 2021
Feb 8, 2019
May 29, 2024
Apr 11, 2019
Feb 8, 2019
Feb 8, 2019
Nov 20, 2013
Aug 9, 2013
May 29, 2024
Feb 8, 2019

Xamarin.Android API Documentation

This repository contains the mdoc(5) format documentation for the assemblies bundled with Xamarin.Android.

Support for Xamarin ended on the 1st May 2024 and so this documentation won't be updated. For more information, see Xamarin Support Policy.

Scripts included in the repository

  • make all: run mdoc validate to verify the syntax of the documentation in the repository
  • make assemble: Create mdoc documentation bundles for installation.
  • make install: Install the documentation bundles into Mono.framework on OS X.

Visualizing the documentation with macdoc

Run macdoc by passing the absolute path to the en directory (i.e. where the index.xml file is) preprended with the character +:

/Applications/Xamarin\ Studio.app/Contents/MacOS/MonoDoc.app/Contents/MacOS/macdoc \
'+/path/to/ios-api-docs/en/'

You need a recent macdoc. You can compile it yourself by cloning https://github.com/mono/monomac and running the build process there. Macdoc is under the samples directory.

Microsoft Open Source Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.