Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@param tags with & in varaible names are not parsed as parameters #176

Open
sudar opened this issue Feb 28, 2016 · 3 comments
Open

@param tags with & in varaible names are not parsed as parameters #176

sudar opened this issue Feb 28, 2016 · 3 comments

Comments

@sudar
Copy link

sudar commented Feb 28, 2016

I originally reported it in WordPress core trac 35974

Below is the summary of the issue.

While documenting hooks, if & is added in the @param tag, then they are not regonized as parameters in the developer docs.

Eg: Look under parameter sub-heading in the following pages
https://developer.wordpress.org/reference/hooks/http_api_curl/
https://developer.wordpress.org/reference/hooks/posts_where/

and about a dozen pages where the parameters are not documented properly.

@JDGrimes
Copy link
Contributor

I did a little digging into this, and it is ultimately an issue with the syntax in question not being supported by phpDocumentor\Reflection\DocBlock. As far as I can tell, this syntax is simply not part of the phpDocumentor standard. Of course, it would be possible for us to reparse the docblock content to handle this however we want, but I just want to be clear that this doesn't appear to be "standard".

@GaryJones
Copy link
Member

@johnbillion
Copy link
Member

Hopefully all of these instances have now been removed from core. See https://core.trac.wordpress.org/ticket/35974.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants