Skip to content

Clarify Javadoc module setup in v2 docs #46

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 8, 2023
Merged

Clarify Javadoc module setup in v2 docs #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/docs/asciidoc/v2/modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,12 +213,11 @@ This dependency improves the support of javadoc tags and comments:
- ``@return ``: is resolved as the `@Operation` response description
- The javadoc comment of an attribute: is resolved as '@Schema' description for this field.

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 `therapi-runtime-javadoc` in order to enable javadoc support for springdoc-openapi.
NOTE: `springdoc-openapi-starter-common` relies on https://github.com/dnault/therapi-runtime-javadoc[`therapi-runtime-javadoc`] to read Javadoc comments at runtime. Ensure that you add it as well as its annotation processor to your project's dependencies. Otherwise, the Javadoc support will fail silently.

[source,xml, subs="attributes+"]
----
<!--Annotation processor -->
<build>
<plugins>
<plugin>
Expand All @@ -236,6 +235,13 @@ NOTE: Make sure, you enable the annotation processor of `therapi-runtime-javadoc
</plugin>
</plugins>
</build>

<!-- Runtime library -->
<dependency>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId>
<version>0.15.0</version>
</dependency>
----

TIP: If both a swagger-annotation description and a javadoc comment are present. The value of the swagger-annotation description will be used.