eclipse-vertx / eclipse-vertx/vertx-codegen

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

オープン
#129 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
111
フォーク
89
PR マージ指標
30日以内にマージされた PR はありません

説明

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?

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず、@VertxGen インターフェースと @DataObject クラスへの @link 参照を含む Java コメントの例で問題を再現し、次に Javascript モジュールのコメントを生成するコード生成パスを追跡します。生成されたコメントがリンクされた参照の後にあるすべてのテキストを保持し、インラインコメントと JSDoc ドキュメントに引き続き使用できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, javascript
領域
tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。