Skip to content

Commit 8b7518b

Browse files
author
Philippe Czaja
committed
docs: document how to include annotated classes from another project
1 parent 32f8341 commit 8b7518b

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,14 @@ classes:
8080
sharedWith: Exposed via API
8181
why: Display in frontend
8282
links:
83-
- cloud.rio.example.adapter.restclient.IncomingDTO
83+
- cloud.rio.example.adapter.restclient.IncomingDTO
8484
fields:
8585
...
8686
- className: cloud.rio.example.adapter.db.PersistedEntity
8787
persisted:
8888
retention: 6 months
8989
responsibleForDeletion: Automatic deletion job
90-
links: []
90+
links: [ ]
9191
fields:
9292
...
9393
- className: cloud.rio.example.adapter.readmodel.ReadModel
@@ -96,7 +96,7 @@ classes:
9696
whereFrom: Some external service
9797
retention: 6 months
9898
responsibleForDeletion: Automatic deletion job
99-
links: []
99+
links: [ ]
100100
fields:
101101
...
102102
```
@@ -116,16 +116,28 @@ dependencies {
116116
}
117117
```
118118

119-
You can configure the documentation generation task to change the output file name and location, and to specify the
120-
configuration files to use, for example in the following way:
119+
You can configure the documentation generation task to
120+
121+
* change the output file name and location
122+
* specify the configuration files to use
123+
* include annotated classes from other projects
124+
The following example shows how to do this:
121125

122126
```kotlin
123127
tasks {
124128
generateGdprDocumentation {
129+
// Change output
125130
markdownReport = file("docs/gdpr/gdpr-documentation.md")
131+
// Specify configuration files
126132
additionalGdprDataFiles.setFrom(
127133
fileTree("src/main/resources") { include("**/gdpr-documentation.yaml") },
128134
)
135+
// Include annotated classes from another project
136+
classpath.from(
137+
configurations.runtimeClasspath.get().filter {
138+
it.name.contains("some-other-project")
139+
}
140+
)
129141
}
130142
}
131143
```

0 commit comments

Comments
 (0)