matzeeable / wp-hookdoc Goto Github PK
View Code? Open in Web Editor NEW:star: An API documentation generator for your WordPress actions and filters.
Home Page: https://devowl.io
License: MIT License
:star: An API documentation generator for your WordPress actions and filters.
Home Page: https://devowl.io
License: MIT License
First: I love what you've done with this repo. It's gotten us very close to a solution. This issue is one of the missing pieces.
The parser misses these functions for some reason: https://developer.wordpress.org/reference/functions/apply_filters_ref_array/
Any thoughts?
The @param
tag is ignored partial. If a parameter is provided it is only visible in the apply_filter('', $...)
arguments list but there is no parameters table with param description and type.
I noticed that in the screenshot included in the README, the do_action
example generated by
wp-hookdoc/template/tmpl/method.tmpl
Line 10 in 6ccbc4a
When referencing namespaced objects, instead of generating a row for the parameter, the table has an empty row:
I tried a bunch of things but I'm afraid none work:
{\\GV\\Template_Context}
{\GV\Template_Context}
{%5GV%5Template_Context}
Then these work, but they show the quotes, which I don't want:
{'\GV\Template_Context'}
{"\GV\Template_Context"}
Here's an example docblock:
/**
* Modify the reserved embed slugs that trigger a warning.
*
* @hook gravityview/rewrite/reserved_slugs
* @since 2.5
*
* @param {array} $reserved_slugs An array of strings, reserved slugs.
* @param {\GV\Template_Context} $gravityview The context.
*
* @returns {array}
*/
I understand that you're simulating @class
by replacing @hook
with @class
and that JS doesn't have that PHP namespace notation, but I'd appreciate guidance!
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.