An API documentation generator for Hack files. The generator works on files that start with
HHAPIDoc generates its own API reference documentation.
This is derived from docs.hhvm.com's documentation generator, and has been in use there for several months.
- Install hhvm
- Install composer
composer.pharto your desired location. Many people put this in their home directory or a global
- Clone this repo
hhvm path/to/composer.phar install
- Verify installation via
hhvm bin/hh-apidoc --help. You should see usage instructions.
hh-apidoc against itself is a good way to test the generator:
hhvm bin/hh-apidoc -o /tmp/docs ./srcThe
-ois where to output the resulting files (it is important to note that the path given to
-omust currently be an existing path).
.means use the current directory as the source.
- See generated
.htmlfiles. You can open
index.htmlin your favorite browser to see the generated documentation.
hh-apidoc is MIT licensed, as found in the LICENSE file.