Skip to content

Commit 75d0d79

Browse files
authored
Merge pull request #46 from ashutoshgngwr/patch-1
Clarify Javadoc module setup in v2 docs
2 parents 8683b62 + e96b6be commit 75d0d79

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/docs/asciidoc/v2/modules.adoc

+9-3
Original file line numberDiff line numberDiff line change
@@ -213,12 +213,11 @@ This dependency improves the support of javadoc tags and comments:
213213
- ``@return ``: is resolved as the `@Operation` response description
214214
- The javadoc comment of an attribute: is resolved as '@Schema' description for this field.
215215

216-
This dependency is based on the library https://github.com/dnault/therapi-runtime-javadoc[therapi-runtime-javadoc]
217-
218-
NOTE: Make sure, you enable the annotation processor of `therapi-runtime-javadoc` in order to enable javadoc support for springdoc-openapi.
216+
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.
219217

220218
[source,xml, subs="attributes+"]
221219
----
220+
<!--Annotation processor -->
222221
<build>
223222
<plugins>
224223
<plugin>
@@ -236,6 +235,13 @@ NOTE: Make sure, you enable the annotation processor of `therapi-runtime-javadoc
236235
</plugin>
237236
</plugins>
238237
</build>
238+
239+
<!-- Runtime library -->
240+
<dependency>
241+
<groupId>com.github.therapi</groupId>
242+
<artifactId>therapi-runtime-javadoc</artifactId>
243+
<version>0.15.0</version>
244+
</dependency>
239245
----
240246

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

0 commit comments

Comments
 (0)