Skip to content

Commit

Permalink
Add API documentation generated by ApiGen.
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffroy-aubry committed Jun 14, 2013
1 parent 5469908 commit b4d255e
Show file tree
Hide file tree
Showing 26 changed files with 4,172 additions and 32 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
@@ -1,6 +1,12 @@
ChangeLog
=========

## Version 1.2.2 (2013-06-14)

Doc:

- Add API documentation generated by [ApiGen](http://apigen.org/).

## Version 1.2.1 (2013-06-05)

Doc :
Expand Down
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -277,6 +277,14 @@ and run `php composer.phar install` from the terminal into the root folder of yo
```

## Documentation
[API documentation](http://htmlpreview.github.io/?https://github.com/geoffroy-aubry/Helpers/blob/stable/doc/api/index.html)
is generated by [ApiGen](http://apigen.org/) in the `doc/api` folder.

```bash
$ php vendor/bin/apigen.php -c apigen.neon
```

## Copyrights & licensing
Licensed under the GNU Lesser General Public License v3 (LGPL version 3).
See [LICENSE](LICENSE) file for details.
Expand Down
49 changes: 49 additions & 0 deletions apigen.neon
@@ -0,0 +1,49 @@
source: [src]

destination: doc/api

extensions: [php]

exclude: [*/tests/*, */Test/*, */vendor/composer]

charset: UTF-8

main: GAubry\Helpers

title: Helpers

groups: namespaces

allowedHtml: [b, i, a, ul, ol, li, p, br, var, samp, kbd, tt]

autocomplete: [classes, constants, functions, methods, properties, classconstants]

accessLevels: [public, protected, private]

internal: No

php: No

tree: Yes

deprecated: Yes

todo: Yes

sourceCode: Yes

download: No

report:

wipeout: Yes

quiet: No

progressbar: No

colors: Yes

updateCheck: No

debug: No
3 changes: 2 additions & 1 deletion composer.json
Expand Up @@ -17,7 +17,8 @@
"phpunit/phpunit": ">=3.7",
"phpmd/phpmd": "1.4.*",
"squizlabs/php_codesniffer": "1.4.*",
"satooshi/php-coveralls": "dev-master"
"satooshi/php-coveralls": "dev-master",
"apigen/apigen": "2.8.0"
},
"autoload": {
"psr-0": {"GAubry\\Helpers": "src/"}
Expand Down

0 comments on commit b4d255e

Please sign in to comment.