-
-
Notifications
You must be signed in to change notification settings - Fork 467
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature-Request] Derive documentation from javadoc #38
Comments
Hi, We are not focusing to use javadoc to generate the OpenAPI Description. |
Would you be willing to reconsider this feature request now that some time has passed? The annotations approach is particularly more verbose, and pulling descriptions from the javadocs would be significantly more ergonomic. |
Any play to reopen this issue? Seems super convenient at first sight (and quite natural from a user perspective as a good default). |
Ditto ⬆️ |
The support will be added with version: For a project that wants to enable <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-javadoc</artifactId>
<version>{springdoc-version}</version>
</dependency> This dependency improves the support of javadoc tags and comments:
This dependency is based on the library https://github.com/dnault/therapi-runtime-javadoc[therapi-runtime-javadoc] NOTE: Make sure, you enable the annotation processor of <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc-scribe</artifactId>
<version>0.12.0</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build> |
This is a feature request.
IMO writing the documentation via annotations is tedious. I would rather write javadocs and let the plugin convert them into proper documentation.
Can you add support for that?
If annotations are present and the description part is filled, then it should use that description. If the annotation is missing or the description is empty, then it should use the javadocs instead.
A helpful library for the implementation might be https://github.com/dnault/therapi-runtime-javadoc
The text was updated successfully, but these errors were encountered: