ffm/hookdocs

Documents observers, rewrites via doc blocks

0.1.0 2017-07-06 08:55 UTC

This package is not auto-updated.

Last update: 2024-11-05 18:08:41 UTC


README

Travis Build

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

Support

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