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

Hook documentation generator - support for param tags #4243

Closed
tsteur opened this issue Oct 26, 2013 · 3 comments
Closed

Hook documentation generator - support for param tags #4243

tsteur opened this issue Oct 26, 2013 · 3 comments
Labels
c: Website matomo.org For issues related to our matomo.org website. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Milestone

Comments

@tsteur
Copy link
Member

tsteur commented Oct 26, 2013

Make it possible to support @param tags. If possible, also provide &$param in @param in hook docs. This will make hook docs clearer.

@tsteur
Copy link
Member Author

tsteur commented Oct 27, 2013

Would be ok like this? https://github.com/piwik/plugins-api-doc-generator/edit/master/docs/Hooks.md#logformatfilemessage

Unfortunately, I do not get the info whether it is @param &$param is used. But it is displayed in the arguments list. If you wonder why it is displayed in function signature but not in params list: The function signature is more or less just the code written in PHP, the params are read/parsed from the comment by the lexer.

@mattab
Copy link
Member

mattab commented Oct 27, 2013

Wow this looks very cool!

maybe you could also put the reference in the params list, by Looking for the string &$var in the function signature string, and if found, add the reference to the param list as well.

@tsteur
Copy link
Member Author

tsteur commented Dec 16, 2013

done.

@tsteur tsteur added this to the 2.0.3 - Piwik 2.0.3 milestone Jul 8, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Website matomo.org For issues related to our matomo.org website. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Projects
None yet
Development

No branches or pull requests

2 participants