googleapis / googleapis/java-docfx-doclet

Create table of Message-specific methods for the Message description

Offen
#239 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
priority: p3 type: feature request
Vorherrschende Sprache
Keine Sprachdaten
Sterne
5
Forks
9
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem Vergleich der generierten PhraseSet Message-Seite mit den Package overview tables und untersuche, wie der doclet die Message description und method sections erstellt. Füge oben auf jeder Message-Seite eine komprimierte Tabelle der Message-specific methods und descriptions hinzu und trenne sie von den generierten base-class methods.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.