search

vaadin / hilla

Build better business applications, faster. No more juggling REST endpoints or deciphering GraphQL queries. Hilla seamlessly connects Spring Boot and React to accelerate application development.
https://hilla.dev
Apache License 2.0
897 stars 56 forks source link

Generate TS docs based on JavaDocs #1135

Open tarekoraby opened 1 year ago

tarekoraby commented 1 year ago

Is your feature request related to a problem? Please describe. The Hilla-generated TS type definitions are missing documentation, making it difficult to know what the different methods and models are representing or doing.

Describe the solution you'd like Add TS documentation of the generated endpoints and models based on the JavaDocs.

platosha commented 1 year ago

Thanks for the idea.

This is something that requires a lot of work to reintroduce Java source parsing to extract the JavaDocs.

Also accessing the source code would be hard when endpoints and entities are coming from Maven / Gradle dependencies.