Giter VIP home page Giter VIP logo

swiftdoc-parser's Introduction

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.

swiftdoc-parser's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.