From 0b110f70c28455ba61dd1d1f1d8f78a36cf64181 Mon Sep 17 00:00:00 2001 From: Yossi Spektor Date: Sat, 24 Jun 2023 22:29:19 +0300 Subject: [PATCH] GH-220 - Documentation polish. --- src/docs/asciidoc/60-documentation.adoc | 5 +++-- src/docs/asciidoc/70-runtime.adoc | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/docs/asciidoc/60-documentation.adoc b/src/docs/asciidoc/60-documentation.adoc index 2ac2b624..3f4e3055 100644 --- a/src/docs/asciidoc/60-documentation.adoc +++ b/src/docs/asciidoc/60-documentation.adoc @@ -183,7 +183,7 @@ package "Application" <> { The Application Module Canvases can be generated by calling `Documenter.writeModuleCanvases()`: -.Generating application module component diagrams using `Documenter` +.Generating application module canvases using `Documenter` [source, java] ---- class DocumentationTests { @@ -199,7 +199,8 @@ class DocumentationTests { } ---- -A canvas generated looks like this: +By default, the documentation will be generated to `spring-modulith-docs` folder in your build system's build folder. +A generated canvas looks like this: .A sample Application Module Canvas [cols="1h,4a"] diff --git a/src/docs/asciidoc/70-runtime.adoc b/src/docs/asciidoc/70-runtime.adoc index 2745a613..fc746263 100644 --- a/src/docs/asciidoc/70-runtime.adoc +++ b/src/docs/asciidoc/70-runtime.adoc @@ -67,7 +67,7 @@ The execution order of those beans will automatically follow the application mod class MyInitializer implements ApplicationModuleInitializer { @Override - void initialize() { + public void initialize() { // Initialization code goes here } }