arrow-docgen/README.md

Arrow API Documentation Generator

# Arrow API Documentation Generator [![Build Status](https://magnum.travis-ci.com/appcelerator/arrow-docgen.svg?token=ph6xdReX6PW2XENunBEH)](https://magnum.travis-ci.com/appcelerator/arrow-docgen)

> This is the Arrow API Documentation Generator library. Requires [arrow-objectmodel](https://github.com/appcelerator/arrow-objectmodel) to generate documentation.

## Usage

To generate a documentation page for the objectmodel, use such as:

```javascript
var docgen = require('arrow-docgen');
docgen.generate(objectmodel, config,function(err, html){
	console.log('completed');
});
```

# License

This source code is licensed as part of the Appcelerator Enterprise Platform and subject to the End User License Agreement and Enterprise License and Ordering Agreement. Copyright (c) 2014 by Appcelerator, Inc. All Rights Reserved. This source code is Proprietary and Confidential to Appcelerator, Inc.