support @internal tag
まだ誰も着手していません。
評価
- 難易度
- 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
- 平均マージ
- 16時間 29分
- マージ済み PR（30日）
- 8
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
WordPress/phpdoc-parser のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
WordPress/phpdoc-parser#269 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
WordPress/phpdoc-parser#268 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
WordPress/phpdoc-parser#254 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
WordPress/phpdoc-parser#246 · コメント 9 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
WordPress/phpdoc-parser#235 · コメント 1 件 ·
WordPress/phpdoc-parser の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
hector-jewell/food-delivery-system-for-restaurant-using-php#1311 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
Sylius/SyliusGridBundle#501 ·