Skip to content

Commit 479b626

Browse files
committed
add docs about swift-java.config
1 parent a11a78a commit 479b626

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Sources/SwiftJavaDocumentation/Documentation.docc/SwiftJavaCommandLineTool.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,3 +254,14 @@ public final class SomeModule ... {
254254
public static void globalFunction() { ... }
255255
}
256256
```
257+
258+
### The swift-java.config file
259+
260+
Many of the tools–as well as SwiftPM plugin's–behaviors can be configured using the `swift-java.config` file.
261+
262+
You can refer to the ``SwiftJavaSharedConfiguration/Configuration`` struct to learn about the supported options.
263+
264+
Configuration from the config files may be overriden or augmented by explicit command line parameters,
265+
please refer to the options documentation for details on their behavior.
266+
267+
> Note: **Comments in configuration**: The configuration is a JSON 5 file, which among other things allows `//` and `/* */` comments, so feel free to add line comments explaining rationale for some of the settings in youf configuration.

0 commit comments

Comments
 (0)