Vertispan / jsinterop-ts-defs

Ingests jsinterop-annotated Java and generates TypeScript definitions
Apache License 2.0
7 stars 3 forks source link

Emit jsdoc consistent with ts users expectations #106

Open niloc132 opened 5 months ago

niloc132 commented 5 months ago

There are a few mismatches between how Javadoc and Java annotations work vs how typescript and typedoc behave around inheritance:

My conclusion is that a Java type/method with a) no javadoc that b) extends from or overrides something deprecated should always have a short typedoc string attached to it:

/**
 * @inheritDoc
 * @deprecated
 */

This will correctly show that the type/member is deprecated, and will still show the expected documentation.