A few days ago I started my first Open Source project (a WordPress Plugin boilerplate, this becomes an own post later…). I decided to create the boilerplate plugin with high quality in focus. High-Quality means also a well documentated plugin (source code). Creating a documentation can be very time-intensive but there are a lot of tools out there for every type of language.
do_action(/* ... */) or
apply_filters(/* ... */).
I created a template and plugin for JSDoc which allows you to parse Docblocks with a
@hook attribute. Both can be found here: https://github.com/matzeeable/wp-hookdoc.
Using the NPM module
Please ensure that your WordPress plugin has already initialized a package.json file. Then you can use the following command to install the npm module and JSDoc:
$ npm install jsdoc -g
$ npm install wp-hookdoc --save-dev
Further instroduction can you find directly on the GitHub Repository: https://github.com/matzeeable/wp-hookdoc#getting-started.
Author: Matthias Günter
Creative designer and programer from Low-Bavaria. I love to simplify things, especially when it comes to WordPress. If you like, you can take a look at my plugins.