Header parsing and HTML generating utilities for SwiftDoc.org
These utilities are built on Node.js and use Graphviz for creating inheritance graphs. To install and run the utilities with these prerequisites:
- Clone or download the project.
- Install dependencies with
npm install. - Use the parser to convert a Swift header to JSON with
./index.js --json-only <filename>.
Other options:
$ ./index.js --help
Usage: node ./index.js [options] [file names...]
Options:
--json-only Output parsed headers as JSON only
--config Location of a configuration file
--output-dir Output directory [default: "./output"]
--url-prefix URL prefix for generated links [default: "/"]
Issues and pull requests should be filed in this repository for problems relating to:
- incorrect or missing declarations
- truncated or missing comments
- errors in hierarchy graphs
For errors in the SwiftDoc.org site itself, see the site's repository instead.
Follow @SwiftDocOrg on Twitter.
All code is available under the MIT License. Autogenerated documentation is © 2015 Apple, Inc. All other content is released under the Creative Commons BY-NC License.