Skip to content

Commit bfd6c64

Browse files
committed
GH-1171 - Improve rendering of trees in reference documentation.
1 parent 711c844 commit bfd6c64

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

src/docs/antora/modules/ROOT/pages/fundamentals.adoc

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,12 @@ Let us have a look at an example arrangement (icon:plus-circle[role=green] denot
131131
[source, subs="+specialchars, macros"]
132132
----
133133
icon:cubes[] Example
134-
─ icon:folder[] src/main/java
134+
─ icon:folder[] src/main/java
135135
├─ icon:cube[] example <1>
136-
| └─ icon:plus-circle[role=green] Application.java
137-
─ icon:cube[] example.inventory <2>
136+
│ ╰─ icon:plus-circle[role=green] Application.java
137+
─ icon:cube[] example.inventory <2>
138138
├─ icon:plus-circle[role=green] InventoryManagement.java
139-
─ icon:minus-circle[role=red] SomethingInventoryInternal.java
139+
─ icon:minus-circle[role=red] SomethingInventoryInternal.java
140140
----
141141
<1> The application's main package `example`.
142142
<2> An application module package `inventory`.
@@ -150,16 +150,16 @@ If an application module package contains sub-packages, types in those might nee
150150
[source, subs="macros, quotes"]
151151
----
152152
icon:cubes[] Example
153-
─ icon:folder[] src/main/java
153+
─ icon:folder[] src/main/java
154154
├─ icon:cube[] example
155-
| └─ icon:plus-circle[role=green] Application.java
155+
│ ╰─ icon:plus-circle[role=green] Application.java
156156
├─ icon:cube[] example.inventory
157-
| ├─ icon:plus-circle[role=green] InventoryManagement.java
158-
| └─ icon:minus-circle[role=red] SomethingInventoryInternal.java
157+
├─ icon:plus-circle[role=green] InventoryManagement.java
158+
│ ╰─ icon:minus-circle[role=red] SomethingInventoryInternal.java
159159
├─ **icon:cube[] example.order**
160-
| └─ icon:plus-circle[role=green] OrderManagement.java
161-
─ icon:cube[] example.order.internal
162-
─ icon:plus-circle[role=green] SomethingOrderInternal.java
160+
│ ╰─ icon:plus-circle[role=green] OrderManagement.java
161+
─ icon:cube[] example.order.internal
162+
─ icon:plus-circle[role=green] SomethingOrderInternal.java
163163
----
164164

165165
In such an arrangement, the `order` package is considered an API package.
@@ -180,32 +180,32 @@ To define nested application modules, explicitly annotate packages that are supp
180180
[source, subs="macros, quotes"]
181181
----
182182
icon:cubes[] Example
183-
─ icon:folder[] src/main/java
184-
|
183+
─ icon:folder[] src/main/java
184+
185185
├─ icon:cube[] example
186-
| └─ icon:plus-circle[role=green] Application.java
187-
|
188-
| -> Inventory
189-
|
186+
│ ╰─ icon:plus-circle[role=green] Application.java
187+
188+
-> Inventory
189+
190190
├─ icon:cube[] example.inventory
191-
| ├─ icon:plus-circle[role=green] InventoryManagement.java
192-
| └─ icon:minus-circle[role=red] SomethingInventoryInternal.java
191+
├─ icon:plus-circle[role=green] InventoryManagement.java
192+
│ ╰─ icon:minus-circle[role=red] SomethingInventoryInternal.java
193193
├─ icon:cube[] example.inventory.internal
194-
| └─ icon:minus-circle[role=red] SomethingInventoryInternal.java
195-
|
196-
| -> Inventory > Nested
197-
|
194+
│ ╰─ icon:minus-circle[role=red] SomethingInventoryInternal.java
195+
196+
-> Inventory > Nested
197+
198198
├─ icon:cube[] example.inventory.nested
199-
| ├─ icon:coffee[] package-info.java // @ApplicationModule
200-
| └─ icon:plus-circle[role=orange] NestedApi.java
199+
├─ icon:coffee[] package-info.java // @ApplicationModule
200+
│ ╰─ icon:plus-circle[role=orange] NestedApi.java
201201
├─ icon:cube[] example.inventory.nested.internal
202-
| └─ icon:minus-circle[role=red] NestedInternal.java
203-
|
204-
| -> Order
205-
|
206-
─ icon:cube[] example.order
202+
│ ╰─ icon:minus-circle[role=red] NestedInternal.java
203+
204+
-> Order
205+
206+
─ icon:cube[] example.order
207207
├─ icon:plus-circle[role=green] OrderManagement.java
208-
─ icon:minus-circle[role=red] SomethingOrderInternal.java
208+
─ icon:minus-circle[role=red] SomethingOrderInternal.java
209209
----
210210

211211
In this example `inventory` is an application module as described xref:fundamentals.adoc#modules.simple[above].
@@ -307,17 +307,17 @@ You achieve that by annotating the `package-info.java` file of those packages wi
307307
[source, text, subs="macros, quotes"]
308308
----
309309
icon:cubes[] Example
310-
─ icon:folder[] src/main/java
310+
─ icon:folder[] src/main/java
311311
├─ icon:cube[] example
312-
| └─ icon:plus-circle[role=green] Application.java
312+
│ ╰─ icon:plus-circle[role=green] Application.java
313313
├─ …
314314
├─ icon:cube[] example.order
315-
| └─ icon:plus-circle[role=green] OrderManagement.java
315+
│ ╰─ icon:plus-circle[role=green] OrderManagement.java
316316
├─ **icon:cube[] example.order.spi**
317-
| ├— icon:coffee[] package-info.java
318-
| └─ icon:plus-circle[role=green] SomeSpiInterface.java
319-
─ icon:cube[] example.order.internal
320-
─ icon:minus-circle[role=red] SomethingOrderInternal.java
317+
├— icon:coffee[] package-info.java
318+
│ ╰─ icon:plus-circle[role=green] SomeSpiInterface.java
319+
─ icon:cube[] example.order.internal
320+
─ icon:minus-circle[role=red] SomethingOrderInternal.java
321321
----
322322

323323
.`package-info.java` in `example.order.spi`

0 commit comments

Comments
 (0)