Header parsing and HTML generating utilities for SwiftDoc.org
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
lib
templates
test
.gitignore
LICENSE
README.md
index.js
package.json
swift-nightly-config.json
swift1.2-config.json
swift2.0-config.json
swift2.1-config.json
swift2.2-config.json
swift3.0-config.json
swift3.1-config.json
swift4.2-config.json

README.md

swiftdoc-parser

Header parsing and HTML generating utilities for SwiftDoc.org

Installation

These utilities are built on Node.js and use Graphviz for creating inheritance graphs. To install and run the utilities with these prerequisites:

  1. Clone or download the project.
  2. Install dependencies with npm install.
  3. 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: "/"]

Contributions

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.

Contact

Follow @SwiftDocOrg on Twitter.

License

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.