eclipse-vertx / eclipse-vertx/vertx-codegen

Generated class-level javascript comments truncate if javadoc comments include @link text

Ouverte
#129 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Java
Étoiles
111
Forks
89
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par reproduire le problème avec l’exemple de commentaire Java contenant des références @link vers une interface @VertxGen et une classe @DataObject, puis suivez le chemin de génération de code qui produit le commentaire du module Javascript. Le travail est terminé lorsque les commentaires générés conservent tout le texte suivant les références liées et restent utilisables pour les commentaires inline et la documentation JSDoc.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java, javascript
Domaine
tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.