eclipse-vertx / eclipse-vertx/vertx-codegen
Generated class-level javascript comments truncate if javadoc comments include @link text
- Lenguaje dominante
- Java
- Estrellas
- 111
- Forks
- 89
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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?
Guía de contribución
Línea de trabajo
Comienza reproduciendo el problema con el ejemplo de comentario de Java que contiene referencias @link a una interfaz @VertxGen y una clase @DataObject; después, sigue la ruta de generación de código que produce el comentario del módulo Javascript. El trabajo estará terminado cuando los comentarios generados conserven todo el texto posterior a las referencias enlazadas y sigan siendo utilizables para comentarios inline y documentación JSDoc.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, javascript
- Área
- tooling
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100