Skip to content

Add methods to JavadocComment to refactor how the Client Overview table is created #2385

@alicejli

Description

@alicejli

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 #2280 and #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.

Metadata

Metadata

Assignees

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions