Download the PHP package appertly/hphpdoc without Composer
On this page you can find all versions of the php package appertly/hphpdoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download appertly/hphpdoc
More information about appertly/hphpdoc
Files in appertly/hphpdoc
Package hphpdoc
Short Description An API documentation generator for Hack/HHVM and PHP
License Apache-2.0
Homepage http://github.com/appertly/hphpdoc
Informations about the package hphpdoc
hphpdoc
API Documentation Generator for Hack/HHVM and PHP
Check out some example documentation: actually, it's our own API. Please have a look.
Installation
You can install this library using Composer:
- The master branch (version 0.x) of this project requires HHVM 3.12 and depends
on
appertly/axe
,appertly/cleopatra
, andfredemmott/definition-finder
.
Compliance
Releases of this library will conform to Semantic Versioning.
Our code is intended to comply with PSR-1, PSR-2, and PSR-4. If you find any issues related to standards compliance, please send a pull request!
Usage
You can view a list of all command line options with the -h
or --help
flags, or by simply calling the hphpdoc
executable with no arguments.
For example:
PHPDoc Syntax
For the most part, we're trying to cover everything in PSR-5. This initial release covers many tags, but not all of them just yet.
Being that Hack has more strict typehints than PHP 5, you can omit types from your @var
, @param
, and @return
PHPDoc tags if you choose!
If your return type or parameter typehint is mixed
, hphpdoc will fall back to the PHPDoc tag type, if one is specified. Example:
All versions of hphpdoc with dependencies
fredemmott/definition-finder Version ^1.3.3
appertly/cleopatra Version ~0.1
appertly/axe Version ~0.1
appertly/axe-markdown Version ~0.1
psr/log Version ^1.0.0