You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/asciidoc/v2/modules.adoc
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -213,12 +213,11 @@ This dependency improves the support of javadoc tags and comments:
213
213
- ``@return ``: is resolved as the `@Operation` response description
214
214
- The javadoc comment of an attribute: is resolved as '@Schema' description for this field.
215
215
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.
219
217
220
218
[source,xml, subs="attributes+"]
221
219
----
220
+
<!--Annotation processor -->
222
221
<build>
223
222
<plugins>
224
223
<plugin>
@@ -236,6 +235,13 @@ NOTE: Make sure, you enable the annotation processor of `therapi-runtime-javadoc
236
235
</plugin>
237
236
</plugins>
238
237
</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>
239
245
----
240
246
241
247
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