eclipse-vertx / eclipse-vertx/vertx-codegen
Generated class-level javascript comments truncate if javadoc comments include @link text
- Lingua principale
- Java
- Stelle
- 111
- Fork
- 89
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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?
Guida per i contributori
Apri la guida per i contributori
Valutazione
Questa issue non è ancora stata valutata.