eclipse-vertx / eclipse-vertx/vertx-codegen

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

Open
#129 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
111
Forks
89
PR merge metrics
No merged PRs in 30d

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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.