/swiftdoc-parser

Header parsing and HTML generating utilities for SwiftDoc.org
  1. Groff 74.1%
  2. JavaScript 22.7%
  3. HTML 3.2%
Groff JavaScript HTML
Find file
Latest commit c9336e1 Sep 20, 2016 @swiftdoc-bot swiftdoc-bot Nightly build of swift/master@8fb4dee, 2016-09-20 01:40:35
Permalink
Failed to load latest commit information.
data Nightly build of swift/master@8fb4dee, 2016-09-20 01:40:35 Sep 20, 2016
lib Updates for Swift 3.0 release Sep 20, 2016
templates Fix output for associatedtype/typealias. Mar 23, 2016
test Recognize vars without explicit get/set as mutable Jun 1, 2015
.gitignore Update .gitignore Mar 23, 2016
LICENSE Initial commit Jan 3, 2015
README.md Initial commit Jan 3, 2015
index.js Updates for Swift 3.0 release Sep 20, 2016
package.json Fix natural compare String issue Mar 26, 2016
swift1.2-config.json Swift 2.0 update. Sep 26, 2015
swift2.0-config.json Additional Swift 2.0 changes. Sep 26, 2015
swift2.1-config.json Updated Swift version. Jan 13, 2016
swift2.2-config.json Add Swift 2.2 for release version of Xcode 7.3 Mar 23, 2016
swift3.0-config.json Updates for Swift 3.0 release Sep 20, 2016
swift3.0-dev-config.json Add config file for nightly builds Sep 20, 2016

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.