Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.48 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.48 KB
Raw

Xamarin.Android API Documentation

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

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.