support @internal tag
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- php
- 领域
- cli, documentation
调研方向
首先跟踪从 PHPDoc 注释创建文章的 wp-cli 命令，并确定 @internal 元素在哪里被处理。实现所请求的默认隐藏和覆盖标志行为，然后验证除非传入该标志，否则内部函数和类会被排除。
由索引模型根据 Issue 内容生成。
描述
I'd like to update the wp-cli commands to not create posts for functions/classes/etc marked as @internal unless an override flag is passed to wp-cli.
When generating documentation from PHPDoc comments it is RECOMMENDED to hide the associated element unless the user has explicitly indicated that internal elements should be included.
An additional use of @internal is to add internal comments or additional description text inline to the Long Description. This may be done, for example, to withhold certain business-critical or confusing information when generating documentation from the source code of this piece of software.
https://github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md#78-internal
- 主要语言
- PHP
- 星标
- 239
- 派生
- 81
- 平均合并
- 1 天 11 小时
- 30 天内合并 PR
- 3
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
WordPress/phpdoc-parser 的其他 Issue
-
Adopt PHPStan for types可能已有人在做 @sirreal 于 5 天前认领。 未关闭
难度 5/5 一周以上 新手友好度 20/100
WordPress/phpdoc-parser#304 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 55/100
WordPress/phpdoc-parser#269 ·
-
Nested union types inside generics are split incorrectly可能已有人在做 @sirreal 于 80 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 64/100
WordPress/phpdoc-parser#268 · 2 条评论 ·
-
Some characters are stripped from documentation可能已有人在做 @sirreal 于 81 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 45/100
WordPress/phpdoc-parser#254 ·
-
难度 5/5 一周以上 新手友好度 35/100
WordPress/phpdoc-parser#246 · 9 条评论 ·
查看 WordPress/phpdoc-parser 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 78/100
backdrop-contrib/commerce#60 ·
-
难度 1/5 1 小时以内 新手友好度 76/100
-
needs-triage Platform(Default)
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
Feature-Request
难度 2/5 1-3 小时 新手友好度 65/100
RSS-Bridge/rss-bridge#5123 ·
维护者通常 1 天内回复
-
[Store] RstLoader detects headings inside indented code blocks可能已有人在做 @lazerg 今天认领。 未关闭Bug Status: Needs Review Store
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复