ffm/hookdocs

Documents observers, rewrites via doc blocks

0.1.0 2017-07-06 08:55 UTC

Requires

• nikic/php-parser: ^3.0
• phpdocumentor/reflection-docblock: ^3.1
• symfony/console: ^3.3

Requires (Dev)

• phpmd/phpmd: ^2.6
• phpstan/phpstan: ^0.7.0
• phpunit/phpunit: ^6.2
• squizlabs/php_codesniffer: ^3.0

MIT

• Sander Mangel

README

document various hook types like observers and aspects for several types of frameworks

Support

• Magento 1 Observers

Usage

• Install via composer
• run via vendor/bin/documenter [job] [path] [link type] [git owner/project] [branch] [output format]

For example: vendor/bin/documenter magento1:observers app/code/community github ffm/project master markdown

Authors

• Sander Mangel

note: for support, please use the Issue Tracker

Contribute

Contributions are more than welcome. Make a Pull Request to help out

Roadmap

• Add short technical analysis on the method attached (Sets order data, loads X objects, etc)
• Magento 2 Observers
• Magento 2 Plugins