Javadoc isn't delomboked
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- java
调研方向
检查 src/main/java 下的 Java 源代码和 pom.xml 中的构建配置,然后将当前的 Maven Javadoc 输出与文档中记录的 builder() 方法进行比较。调查所提议的 lombok-maven-plugin delombok 设置,并验证 mvn javadoc:javadoc 生成的文档包含生成的方法。
由索引模型根据 Issue 内容生成。
描述
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 that helps. I've tried it and it seems to work. The steps are:
- Moving the source code from
src/main/javatosrc/main/lombok - Adding the following stanza to
pom.xml:
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
<version>1.18.10.0</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>delombok</goal>
</goals>
</execution>
</executions>
</plugin>
After that, the javadoc goal produces the full documentation.
- 主要语言
- Java
- 星标
- 30
- 派生
- 48
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
aws-cloudformation/cloudformation-cli-java-plugin 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 25/100
aws-cloudformation/cloudformation-cli-java-plugin#415 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 42/100
-
难度 5/5 一周以上 新手友好度 25/100
-
难度 4/5 3-5 天 新手友好度 20/100
-
injectCredentialsAndInvokeV2 method in proxy class doesn't support API's like PutObject from S3. 未关闭
难度 5/5 一周以上 新手友好度 25/100
查看 aws-cloudformation/cloudformation-cli-java-plugin 的全部 Issue
相似的 Issue
-
awaiting triage bug Causes friction Hop Gui P1 P2 Transforms
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
apache/flink-agents#1152 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 70/100
jenkinsci/blueocean-plugin#5417 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
objectionary/eo-graphs#75 ·