{"_id":"wp-hookdoc","_rev":"4-703903443530b7bdd1b8ca42b61f519f","name":"wp-hookdoc","description":"An API documentation generator for your WordPress actions and filters.","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"wp-hookdoc","version":"0.1.0","description":"An API documentation generator for your WordPress actions and filters.","main":"index.js","directories":{"example":"example"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","example":"rm -rf example/out && jsdoc example/src -c example/hookdoc.json"},"repository":{"type":"git","url":"git+https://github.com/matzeeable/wp-hookdoc.git"},"keywords":["action","filters","wordpress","documentation","docs"],"author":{"name":"Matthias Günter","email":"support@matthias-web.com"},"license":"MIT","bugs":{"url":"https://github.com/matzeeable/wp-hookdoc/issues"},"homepage":"https://github.com/matzeeable/wp-hookdoc#readme","gitHead":"6ccbc4ababd5fc703a24a7e552a59861457c8cef","_id":"wp-hookdoc@0.1.0","_npmVersion":"5.3.0","_nodeVersion":"8.2.1","_npmUser":{"name":"matzeeable","email":"matzeeable@gmail.com"},"dist":{"integrity":"sha512-cn35OjTAu6Ad4dK6QACTzNu0hxSrRaQIuT8JuB6/+zlpexbiqcNyr0BI7R+j4ZKesDfQ0wNmJtSasRPX70wKvg==","shasum":"934ceca5e7956ec4fc02c939fbe3d2f70dd2e4d4","tarball":"https://registry.npmjs.org/wp-hookdoc/-/wp-hookdoc-0.1.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDPcAjZdjujsKg8KDP9DZ3IbBfmQ4+sld6ZTnn3AlBhLQIhAO9lfJNcsW+0X1XtYXkZEKByaw1mAZEYyvwLbJyp5OW9"}]},"maintainers":[{"name":"matzeeable","email":"matzeeable@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/wp-hookdoc-0.1.0.tgz_1510759732573_0.515000419691205"}},"0.1.1":{"name":"wp-hookdoc","version":"0.1.1","description":"An API documentation generator for your WordPress actions and filters.","main":"index.js","directories":{"example":"example"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","example":"rm -rf example/out && jsdoc example/src -c example/hookdoc.json"},"repository":{"type":"git","url":"git+https://github.com/matzeeable/wp-hookdoc.git"},"keywords":["action","filters","wordpress","documentation","docs"],"author":{"name":"Matthias Günter","email":"support@matthias-web.com"},"license":"MIT","bugs":{"url":"https://github.com/matzeeable/wp-hookdoc/issues"},"homepage":"https://github.com/matzeeable/wp-hookdoc#readme","gitHead":"7465ddf41c7ffc79fedb0aa8cf4524a66a57347a","_id":"wp-hookdoc@0.1.1","_npmVersion":"5.3.0","_nodeVersion":"8.2.1","_npmUser":{"name":"matzeeable","email":"matzeeable@gmail.com"},"dist":{"integrity":"sha512-kmGuirL8nRjJDyHrX3l0W/vZhBcKU7uthUOY1wSgS4n2A2lURplWPGlRPEYxHNEbUAfGeJOIgdn1hA67r4I9Ww==","shasum":"5ad75fd6bbaf3a224a7de230829158dfa49c6cbb","tarball":"https://registry.npmjs.org/wp-hookdoc/-/wp-hookdoc-0.1.1.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG4GMwJS0THPeiRYKhHrW37Tvodl9c34lfGUeUtg8XBmAiEAs/wnvaQXeNvGhciNRWPAm9Mn0OUaUcbCTKs80Uox2Fs="}]},"maintainers":[{"name":"matzeeable","email":"matzeeable@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/wp-hookdoc-0.1.1.tgz_1510760348868_0.7667469577863812"}},"0.2.0":{"name":"wp-hookdoc","version":"0.2.0","description":"An API documentation generator for your WordPress actions and filters.","main":"index.js","directories":{"example":"example"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","example":"rm -rf example/out && jsdoc example/src -c example/hookdoc.json"},"repository":{"type":"git","url":"git+https://github.com/matzeeable/wp-hookdoc.git"},"keywords":["action","filters","wordpress","documentation","docs"],"author":{"name":"Matthias Günter","email":"support@matthias-web.com"},"license":"MIT","bugs":{"url":"https://github.com/matzeeable/wp-hookdoc/issues"},"homepage":"https://github.com/matzeeable/wp-hookdoc#readme","gitHead":"b1a620a4049bb71116680a1281b1b822db2bd930","_id":"wp-hookdoc@0.2.0","_npmVersion":"5.3.0","_nodeVersion":"8.2.1","_npmUser":{"name":"matzeeable","email":"matzeeable@gmail.com"},"dist":{"integrity":"sha512-BDVfqSA+L7Ho99McFu0ATwJRddaSVbUH/lgoe4RFP7Ktg3kiRtp7VHGIIdn+QhQN7ZtLmCBMpqtEChDvaGDppw==","shasum":"d416dff8880ed7c32efcc86d6881aa4cbd758e42","tarball":"https://registry.npmjs.org/wp-hookdoc/-/wp-hookdoc-0.2.0.tgz","fileCount":77,"unpackedSize":2079770,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDWWJjQj5f/2vQNjMOAnYQGhchebzVW3zFFTA2nbQwYHgIgVk54oBnG6Ntp+d3T52dBcdz3kCCXBacuumvwmCl1618="}]},"maintainers":[{"name":"matzeeable","email":"matzeeable@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/wp-hookdoc_0.2.0_1518943799243_0.004110233686599907"},"_hasShrinkwrap":false}},"readme":"# WordPress HookDoc\nAutomate documentation of [**Actions**](https://codex.wordpress.org/Plugin_API/Action_Reference) and [**Filters**](https://codex.wordpress.org/Plugin_API/Filter_Reference) in WordPress. This npm module needs the [**JSDoc3**](https://github.com/jsdoc3/jsdoc) module as dependency. It uses JSDoc3 as comment parser and generates a documentation with the power of JSDoc.\n\n## Getting started\nSimply install via:\n```sh\n$ npm install jsdoc -g\n$ npm install wp-hookdoc --save-dev\n```\n\nIn your JSDoc configuration file `hookdoc-conf.json` the following options are essential (create a seperate configuration file if you already use JSDoc):\n```js\n{\n    \"opts\": {\n        \"template\": \"node_modules/wp-hookdoc/template\"\n    },\n    \"source\": {\n        \"includePattern\": \".+\\\\.(php|inc)?$\"\n    },\n    \"plugins\": [\n        \"node_modules/wp-hookdoc/plugin\"\n    ]\n}\n```\n\nRun your `jsdoc` command with the input files and `-c hookdoc-conf.json`.\n\n### Define Action Docblock\nDefine `@hook` attribute with the name of the action:\n```php\n<?php\n/**\n * Enqueue scripts for all admin pages.\n *\n * @since 2.8.0\n * @hook admin_enqueue_scripts\n * @param {string} $hook_suffix The current admin page.\n */\ndo_action( 'admin_enqueue_scripts', $hook_suffix );\n```\n\n### Define Filter Docblock\nDefine `@hook` attribute with the name of the filter and a `@returns` attribute:\n```php\n/**\n * Filters the title tag content for an admin page.\n *\n * @since 3.1.0\n * @hook admin_title\n * @param {string} $admin_title The page title, with extra context added.\n * @param {string} $title       The original page title.\n * @returns {string} The title\n */\n$admin_title = apply_filters( 'admin_title', $admin_title, $title );\n```\n\n## Generate example documentation\nTo generate an example documentation change to the `node_modules/wp-hookdoc` folder and run:\n```sh\nnpm run example\n```\n\nYou will find the output in `node_modules/wp-hookdoc/example/out`:\n![example output](https://i.imgur.com/7UmzmLz.png)\n\n## License\nThis module is MIT licensed.","maintainers":[{"name":"matzeeable","email":"matzeeable@gmail.com"}],"time":{"modified":"2022-05-24T17:39:02.576Z","created":"2017-11-15T15:28:54.074Z","0.1.0":"2017-11-15T15:28:54.074Z","0.1.1":"2017-11-15T15:39:10.570Z","0.2.0":"2018-02-18T08:49:59.427Z"},"homepage":"https://github.com/matzeeable/wp-hookdoc#readme","keywords":["action","filters","wordpress","documentation","docs"],"repository":{"type":"git","url":"git+https://github.com/matzeeable/wp-hookdoc.git"},"author":{"name":"Matthias Günter","email":"support@matthias-web.com"},"bugs":{"url":"https://github.com/matzeeable/wp-hookdoc/issues"},"license":"MIT","readmeFilename":"README.md"}