Spring/spring-modulith
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-713 - Polishing.

Browse Source
This commit is contained in:
Oliver Drotbohm
2024-07-08 17:10:15 +02:00
parent b94d13b717
commit 570f347cd8
4 changed files with 88 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/docs/antora/modules/ROOT/pages/documentation.adoc
View File

@@ -308,7 +308,8 @@ Requires the usage of the `spring-boot-configuration-processor` artifact to extr
[[aggregating-document]]
== Generating an Aggregating Document
The aggregating document can be generated by calling `Documenter.writeAggregatingDocument()`:
When using `Documenter.writeDocumentation(…)` an `all-docs.adoc` file will be generated, linking all generated diagrams and Application Module Canvases.
We can manually generate the aggregating document by calling `Documenter.writeAggregatingDocument()`:
.Generating an aggregating document using `Documenter`
[tabs]
@@ -325,7 +326,7 @@ class DocumentationTests {
void writeDocumentationSnippets() {
new Documenter(modules)
.writeAggregatingDocument();
.writeAggregatingDocument();
}
}
----
@@ -346,4 +347,5 @@ class DocumentationTests {
----
======
The aggregating document will include any existing application module component diagrams and application module canvases. If there are none, then this method will not produce an output file.
The aggregating document will include any existing application module component diagrams and application module canvases.
If there are none, then this method will not produce an output file.