Skip to content

Commit fe722ac

Browse files
committed
doc update
1 parent 090a012 commit fe722ac

File tree

5 files changed

+29
-19
lines changed

5 files changed

+29
-19
lines changed

docs/faq.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,7 @@ <h3 id="_how_can_i_deploy_springdoc_openapi_ui_behind_a_reverse_proxy"><a class=
550550
</div>
551551
<div class="listingblock">
552552
<div class="content">
553-
<pre>RequestHeader=set X-Forwarded-Prefix "/custom-path"</pre>
553+
<pre>RequestHeader set X-Forwarded-Prefix "/custom-path"</pre>
554554
</div>
555555
</div>
556556
<div class="ulist">
@@ -1972,7 +1972,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
19721972
</div>
19731973
<div id="footer">
19741974
<div id="footer-text">
1975-
Last updated 2022-11-25 15:05:37 +0100
1975+
Last updated 2023-03-07 21:59:39 +0100
19761976
</div>
19771977
</div>
19781978
</div>

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2980,7 +2980,7 @@ <h3 id="how-can-i-deploy-springdoc-openapi-ui-behind-a-reverse-proxy"><a class="
29802980
</div>
29812981
<div class="listingblock">
29822982
<div class="content">
2983-
<pre>RequestHeader=set X-Forwarded-Prefix "/custom-path"</pre>
2983+
<pre>RequestHeader set X-Forwarded-Prefix "/custom-path"</pre>
29842984
</div>
29852985
</div>
29862986
<div class="ulist">

docs/v2/faq.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ <h3 id="_how_can_i_deploy_springdoc_openapi_starter_webmvc_ui_behind_a_reverse_p
541541
</div>
542542
<div class="listingblock">
543543
<div class="content">
544-
<pre>RequestHeader=set X-Forwarded-Prefix "/custom-path"</pre>
544+
<pre>RequestHeader set X-Forwarded-Prefix "/custom-path"</pre>
545545
</div>
546546
</div>
547547
<div class="ulist">
@@ -1869,7 +1869,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18691869
</div>
18701870
<div id="footer">
18711871
<div id="footer-text">
1872-
Last updated 2023-02-21 20:50:45 +0100
1872+
Last updated 2023-03-07 21:59:39 +0100
18731873
</div>
18741874
</div>
18751875
</div>

docs/v2/index.html

+12-7
Original file line numberDiff line numberDiff line change
@@ -785,24 +785,22 @@ <h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.11. Jav
785785
</li>
786786
</ul>
787787
</div>
788-
<div class="paragraph">
789-
<p>This dependency is based on the library <a href="https://github.com/dnault/therapi-runtime-javadoc">therapi-runtime-javadoc</a></p>
790-
</div>
791788
<div class="admonitionblock note">
792789
<table>
793790
<tr>
794791
<td class="icon">
795792
<i class="fa icon-note" title="Note"></i>
796793
</td>
797794
<td class="content">
798-
Make sure, you enable the annotation processor of <code>therapi-runtime-javadoc</code> in order to enable javadoc support for springdoc-openapi.
795+
<code>springdoc-openapi-starter-common</code> relies on <a href="https://github.com/dnault/therapi-runtime-javadoc"><code>therapi-runtime-javadoc</code></a> to read Javadoc comments at runtime. Ensure that you add it as well as its annotation processor to your project&#8217;s dependencies. Otherwise, the Javadoc support will fail silently.
799796
</td>
800797
</tr>
801798
</table>
802799
</div>
803800
<div class="listingblock">
804801
<div class="content">
805-
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;build&gt;
802+
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;!--Annotation processor --&gt;
803+
&lt;build&gt;
806804
&lt;plugins&gt;
807805
&lt;plugin&gt;
808806
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
@@ -818,7 +816,14 @@ <h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.11. Jav
818816
&lt;/configuration&gt;
819817
&lt;/plugin&gt;
820818
&lt;/plugins&gt;
821-
&lt;/build&gt;</code></pre>
819+
&lt;/build&gt;
820+
821+
&lt;!-- Runtime library --&gt;
822+
&lt;dependency&gt;
823+
&lt;groupId&gt;com.github.therapi&lt;/groupId&gt;
824+
&lt;artifactId&gt;therapi-runtime-javadoc&lt;/artifactId&gt;
825+
&lt;version&gt;0.15.0&lt;/version&gt;
826+
&lt;/dependency&gt;</code></pre>
822827
</div>
823828
</div>
824829
<div class="admonitionblock tip">
@@ -3028,7 +3033,7 @@ <h3 id="how-can-i-deploy-springdoc-openapi-starter-webmvc-ui-behind-a-reverse-pr
30283033
</div>
30293034
<div class="listingblock">
30303035
<div class="content">
3031-
<pre>RequestHeader=set X-Forwarded-Prefix "/custom-path"</pre>
3036+
<pre>RequestHeader set X-Forwarded-Prefix "/custom-path"</pre>
30323037
</div>
30333038
</div>
30343039
<div class="ulist">

docs/v2/modules.html

+12-7
Original file line numberDiff line numberDiff line change
@@ -454,24 +454,22 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
454454
</li>
455455
</ul>
456456
</div>
457-
<div class="paragraph">
458-
<p>This dependency is based on the library <a href="https://github.com/dnault/therapi-runtime-javadoc">therapi-runtime-javadoc</a></p>
459-
</div>
460457
<div class="admonitionblock note">
461458
<table>
462459
<tr>
463460
<td class="icon">
464461
<i class="fa icon-note" title="Note"></i>
465462
</td>
466463
<td class="content">
467-
Make sure, you enable the annotation processor of <code>therapi-runtime-javadoc</code> in order to enable javadoc support for springdoc-openapi.
464+
<code>springdoc-openapi-starter-common</code> relies on <a href="https://github.com/dnault/therapi-runtime-javadoc"><code>therapi-runtime-javadoc</code></a> to read Javadoc comments at runtime. Ensure that you add it as well as its annotation processor to your project&#8217;s dependencies. Otherwise, the Javadoc support will fail silently.
468465
</td>
469466
</tr>
470467
</table>
471468
</div>
472469
<div class="listingblock">
473470
<div class="content">
474-
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;build&gt;
471+
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;!--Annotation processor --&gt;
472+
&lt;build&gt;
475473
&lt;plugins&gt;
476474
&lt;plugin&gt;
477475
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
@@ -487,7 +485,14 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
487485
&lt;/configuration&gt;
488486
&lt;/plugin&gt;
489487
&lt;/plugins&gt;
490-
&lt;/build&gt;</code></pre>
488+
&lt;/build&gt;
489+
490+
&lt;!-- Runtime library --&gt;
491+
&lt;dependency&gt;
492+
&lt;groupId&gt;com.github.therapi&lt;/groupId&gt;
493+
&lt;artifactId&gt;therapi-runtime-javadoc&lt;/artifactId&gt;
494+
&lt;version&gt;0.15.0&lt;/version&gt;
495+
&lt;/dependency&gt;</code></pre>
491496
</div>
492497
</div>
493498
<div class="admonitionblock tip">
@@ -508,7 +513,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
508513
</div>
509514
<div id="footer">
510515
<div id="footer-text">
511-
Last updated 2022-12-16 15:14:24 +0100
516+
Last updated 2023-03-07 21:59:39 +0100
512517
</div>
513518
</div>
514519
</div>

0 commit comments

Comments
 (0)