googleapis / googleapis/java-docfx-doclet

Create table of Message-specific methods for the Message description

Aperta
#239 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
priority: p3 type: feature request
Lingua principale
Nessun dato sulla lingua
Stelle
5
Fork
9
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Currently the c.g.c pages for Messages combine generated base class methods with Message-specific methods.

For instance for `PhraseSet` part of google.cloud.speech, the base class methods `equals` and `hashcode()` are at the same level as `containsAnnotations` and `getKmsKeyName`.

Ideally, as part of the Enum description at the top of the page, there would be a condensed table of Message-specific methods and the description of what the method does, similar to the tables on the Package overviews.

![BJueebzdHegYCji](https://github.com/googleapis/java-docfx-doclet/assets/65933803/479c37d0-2843-48fd-a853-b36ebf3a5cd6)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start by comparing the generated PhraseSet Message page with the Package overview tables and inspect how the doclet builds the Message description and method sections. Add a condensed table of Message-specific methods and descriptions near the top of each Message page, separating them from generated base-class methods.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.