aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin

Javadoc isn't delomboked

オープン
#234 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
30
フォーク
48
PR マージ指標
30日以内にマージされた PR はありません

説明

The documentation generated by `mvn javadoc:javadoc` is missing the methods auto-generated by Lombok. So, the documentation is missing methods like `builder()` that are used in our examples.

There's a [Maven plugin](http://anthonywhitford.com/lombok.maven/lombok-maven-plugin/index.html) that helps. I've tried it and it seems to work. The steps are:

1. Moving the source code from `src/main/java` to `src/main/lombok`
2. Adding the following stanza to `pom.xml`:

```xml

org.projectlombok
lombok-maven-plugin
1.18.10.0


generate-sources

delombok




```

After that, the javadoc goal produces the full documentation.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。