Comments (3)
Excluding files should be fixed in 3422b48.
We could introduce a --ignore-unsupported-tag-names
flag or introduce something like:
- https://phpstan.org/user-guide/ignoring-errors#ignoring-in-code-using-phpdocs
- https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file
/**
* Docblock.
*
* @pronamic-wp-documentor-ignore This action cannot be documented due to the dynamic tag name.
*/
do_action( $atts['hook_name'] );
Is excluding the file enough or do you lean more towards the above?
from wp-documentor.
I’d love a more granular control, but in the end it depends on feasibility.
I have personally only one filter and one action in that file and it’s accidentally each the unsupported one.
But who knows this could be something useful actually to exclude by tags, because sometimes I also want to exclude filters or actions just because they shouldn’t be documented
perhaps listening to an @ignore tag would be better so the document block can control it instead of the hook tag?
(Honestly I’ve not even tried if this would actually already do the trick)
from wp-documentor.
Add support for the @ignore
tag seems like a great solution to me, added a new issue for this:
from wp-documentor.
Related Issues (16)
- Improve support for @since tag HOT 1
- List of arguments is empty when `apply_filters` is returned instead of assigned to variable HOT 1
- Add support for `@ignore` tag HOT 2
- Add ability to ignore a specific hook
- Dynamic filter HOT 2
- Empty list of arguments when `apply_filters` is used in a conditional clause instead of assigned to a variable HOT 2
- Empty list of arguments when casting the value returned by `apply_filters`
- Fix "Deprecated: Creation of dynamic property" HOT 1
- Add phpDocumentor guide example
- Add support for `--output` option instead of piping output to a file HOT 1
- Add support for external URL in relative markdown links
- Add support for exclude HOT 1
- Add Progress Bar HOT 1
- Add a way to separate actions and filters in different (markdown) files
- Render @link tags in markdown template
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from wp-documentor.