eclipse-vertx / eclipse-vertx/vertx-codegen
Generated class-level javascript comments truncate if javadoc comments include @link text
- Vorherrschende Sprache
- Java
- Sterne
- 111
- Forks
- 89
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
A javadoc comment that contains a link to any other `@VertxGen` interface or `@DataObject` class has the effect of truncating the corresponding comments in the generated Javascript code after the last line that does not contain any links.
For example, this class comment in Java:
```java
/**
* This thing does a thing or two
*
* Here is a link to an interface:
* Some preface text {@link org.github.hoobajoob.vertx.api.MyInterface} some post text
*
*
* Here is a link to a DataObject:
* Some preface text {@link org.github.hoobajoob.vertx.api.MyDataObject} some post text
*
*/
```
...produces this module comment in Javascript:
```javascript
/**
This thing does a thing or two
Here is a link to an interface:
@class
*/
```
This makes inline code comments and JSDoc-generated api documentation practically unusable for Javascript users of codegen-generated libraries.
Is this a known defect? Is there a workaround?
Beitragsleitfaden
Rechercherichtung
Beginne damit, das Problem mit dem Java-Kommentar-Beispiel zu reproduzieren, das @link-Referenzen auf ein @VertxGen-Interface und eine @DataObject-Klasse enthält, und verfolge dann den Codegenerierungspfad, der den Kommentar des Javascript-Moduls erzeugt. Als erledigt gilt die Aufgabe, wenn generierte Kommentare den gesamten Text nach verknüpften Referenzen beibehalten und für Inline-Kommentare und JSDoc-Dokumentation weiterhin verwendbar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java, javascript
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100