[MPLUGIN-536] Allow generation of documentation for nested POJOs used as @Parameters
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- java
調査の方向性
まず、生成されたサイトドキュメントと、@Parameter でマークされたフィールドの mojo での処理を追跡し、次に、ネストされた POJO が現在どのように表現されているかを調べます。sources、dependency sources、JavaDoc JARs、またはカスタムの @Documentation アノテーションのどれが意図された設計なのかを明確にします。done には、完全修飾クラス名だけでなく、ドキュメント化されたネスト属性を含める必要があります。
索引モデルが issue の本文から書いたものです。
説明
Ashley Scopes opened MPLUGIN-536 and commented
As a plugin developer of a plugin with a few dozen complex options, I'd like to see a new feature where by the generated site documentation and help mojo document the fields of nested pojos that are present with javadoc comments.
@Parameter
private Thing thing;
public class Thing {
public Foo getFoo() { ... }
public void setFoo(Foo foo) { ... }
}
Currently the plugins just report the fully qualified class name as a dead link, which means nested attributes have to be documented manually and the consistency of this varies wildly between projects.
I'd either like to see the ability for the documentation to be generated from project sources, dependency sources, or JavaDoc JARs, or the ability to provide a custom @Documentation annotation to document attributes in nested objects.
This could be specified within a "schemas" section at the bottom of the goal HTML page.
No further details from MPLUGIN-536
- 主要言語
- Java
- スター
- 63
- フォーク
- 78
- 平均マージ
- 1日 4時間
- マージ済み PR（30日）
- 23
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/maven-plugin-tools のほかの issue
-
`@Execute` with a custom phase or `"none"` fails descriptor extraction対応中かも @CaptainAni187 が 27 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
apache/maven-plugin-tools#1232 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
apache/maven-plugin-tools#1240 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
apache/maven-plugin-tools#1233 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
-
`descriptor` fails on `onlineRequired`, `dependencyCollection` and `dependencyResolutionPathScopes` in the Maven 4 API `@Mojo`対応中かも @efegokdemir が 25 日前に担当しました。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 65/100
apache/maven-plugin-tools#1231 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
`@Resolution` fields stay null: `plugin.xml` gets no `<resolutions>`対応中かも @goutamadwant が 30 日前に担当しました。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
apache/maven-plugin-tools#1230 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
apache/maven-plugin-tools の issue をすべて見る
似ている issue
-
BindingServiceProperties.bindings regressed to a non-thread-safe TreeMap in GH-3158: concurrent first use of binding names corrupts it対応中かも @AkashB23 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
spring-cloud/spring-cloud-stream#3321 ·
メンテナーはふだん 1 日以内に返信
-
[Bug] 资源包列表 与 模组/数据包/世界 列表排列顺序不一致対応中かも @fishdry1000 が 4 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
ai-driven-fuzzing bug claude Minor
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
linagora/twake-calendar-side-service#1333 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
AtlasOfLivingAustralia/species-lists#882 ·
メンテナーはふだん 1 日以内に返信
-
Type/Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
ballerina-platform/ballerina-library#9458 ·
メンテナーはふだん 1 日以内に返信