eclipse-vertx / eclipse-vertx/vertx-codegen

Generated javascript comments for DataObjects mishandles links in javadoc comments

Aperta
#130 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
111
Fork
89
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Data objects with setter method comments that contain links like the [`backendConfiguration` property of `ServiceDiscoveryOptions`](https://github.com/vert-x3/vertx-service-discovery/blob/bc6c6847c818d2902c59d7aaf7aa36f32c5855a5/vertx-service-discovery/src/main/java/io/vertx/servicediscovery/ServiceDiscoveryOptions.java#L110-L117) or the [`location` property of `Record`](https://github.com/vert-x3/vertx-service-discovery/blob/bc6c6847c818d2902c59d7aaf7aa36f32c5855a5/vertx-service-discovery/src/main/java/io/vertx/servicediscovery/Record.java#L94-L100) generate Javascript comments where the link is either [omitted](https://github.com/vert-x3/vertx-service-discovery/blob/bc6c6847c818d2902c59d7aaf7aa36f32c5855a5/vertx-service-discovery/src/main/asciidoc/dataobjects.adoc#servicediscoveryoptions) or [converted to the word 'link'](https://github.com/vert-x3/vertx-service-discovery/blob/bc6c6847c818d2902c59d7aaf7aa36f32c5855a5/vertx-service-discovery/src/main/asciidoc/dataobjects.adoc#record).

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con i commenti dei setter collegati in ServiceDiscoveryOptions.java e Record.java, quindi confronta le voci generate in dataobjects.adoc. Traccia il modo in cui i link Javadoc vengono convertiti in commenti JavaScript generati. Il lavoro è completo quando i link vengono mantenuti correttamente invece di essere omessi o visualizzati come la parola “link”; nell’issue non viene indicato alcun punto di ingresso per i test.

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

Valutazione

Stack tecnologico
java, javascript
Ambito
tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 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.