googleapis / googleapis/google-cloud-java
[sdk-platform-java] Add methods to JavadocComment to refactor how the Client Overview table is created
- 主要语言
- Java
- 星标
- 2.1k
- 派生
- 1.2k
- 平均合并
- 1 天 23 小时
- 30 天内合并 PR
- 157
描述
The Client Overview table in https://github.com/googleapis/sdk-platform-java/blob/main/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java#L221 has been brittle in terms of ensuring proper formatting of all of its elements. (See https://github.com/googleapis/sdk-platform-java/pull/2280 and https://github.com/googleapis/sdk-platform-java/pull/2361 as piecemeal fixes)
It would be better to refactor this table to ensure all elements are always properly formatted. Likely some new methods will need to be added to `JavaDocComment`.
贡献指南
调研方向
从 ServiceClientCommentComposer.java 中约第 221 行的 Client Overview 表开始,然后检查 JavaDocComment 以及 pull request 2280 和 2361 中的零散修复。确定哪些格式化职责应移入 JavaDocComment 的方法中,并验证所有表格元素的格式是否一致,而不依赖进一步的零散修复。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- documentation
- Issue 类型
- 重构
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100