Skip to content

Commit 6b92bc0

Browse files
committed
fix: documenting configuration properties uses correct syntax
1 parent 57771dd commit 6b92bc0

File tree

3 files changed

+31
-16
lines changed

3 files changed

+31
-16
lines changed

server/src/main/kotlin/com/adobe/testing/s3mock/S3MockProperties.kt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2017-2025 Adobe.
2+
* Copyright 2017-2026 Adobe.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,8 +20,10 @@ import org.springframework.boot.context.properties.ConfigurationProperties
2020
@ConfigurationProperties("com.adobe.testing.s3mock")
2121
@JvmRecord
2222
data class S3MockProperties(
23-
// Property name for passing the HTTPS port to use. Defaults to
24-
// {@value S3MockApplication#DEFAULT_HTTPS_PORT}. If set to
25-
// {@value S3MockApplication#RANDOM_PORT}, a random port will be chosen.
23+
/**
24+
* Property name for passing the HTTPS port to use. Defaults to
25+
* {@value S3MockApplication#DEFAULT_HTTPS_PORT}. If set to
26+
* {@value S3MockApplication#RANDOM_PORT}, a random port will be chosen.
27+
*/
2628
val httpPort: Int
2729
)

server/src/main/kotlin/com/adobe/testing/s3mock/controller/ControllerProperties.kt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2017-2025 Adobe.
2+
* Copyright 2017-2026 Adobe.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,9 +20,11 @@ import org.springframework.boot.context.properties.bind.DefaultValue
2020

2121
@ConfigurationProperties("com.adobe.testing.s3mock.controller")
2222
@JvmRecord
23-
data class ControllerProperties( // Property name for passing the global context path to use.
24-
// Defaults to "".
25-
// For example if set to `s3-mock` all endpoints will be available at
26-
// `http://host:port/s3-mock` instead of `http://host:port/`
23+
data class ControllerProperties(
24+
/**
25+
* Property name for passing the global context path to use.
26+
* Defaults to "".
27+
* For example if set to `s3-mock` all endpoints will be available at `http://host:port/s3-mock` instead of `http://host:port/`
28+
*/
2729
@param:DefaultValue("") val contextPath: String
2830
)

server/src/main/kotlin/com/adobe/testing/s3mock/store/StoreProperties.kt

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2017-2025 Adobe.
2+
* Copyright 2017-2026 Adobe.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,15 +23,26 @@ import software.amazon.awssdk.regions.Region
2323
@JvmRecord
2424
@ConfigurationProperties("com.adobe.testing.s3mock.store")
2525
data class StoreProperties(
26-
// True if files should be retained when S3Mock exits gracefully.
27-
// False to let S3Mock delete all files when S3Mock exits gracefully.
26+
/**
27+
* True if files should be retained when S3Mock exits gracefully.
28+
* False to let S3Mock delete all files when S3Mock exits gracefully.
29+
*/
2830
@param:DefaultValue("false") val retainFilesOnExit: Boolean,
29-
// The root directory to use. If omitted a default temp-dir will be used.
31+
/**
32+
* The root directory to use. If omitted a default temp-dir will be used.
33+
*/
3034
@param:DefaultValue("") val root: String,
35+
/**
36+
* A set of KMS keys that S3Mock should treat as valid.
37+
*/
3138
@param:DefaultValue("") val validKmsKeys: Set<String>,
32-
// A comma separated list of buckets that are to be created at startup.
39+
/**
40+
* A comma separated list of buckets that are to be created at startup.
41+
*/
3342
@param:DefaultValue("") val initialBuckets: List<String>,
34-
// Region is S3Mock is supposed to mock.
35-
// Must be an official AWS region string like "us-east-1"
43+
/**
44+
* Region is S3Mock is supposed to mock.
45+
* Must be an official AWS region string like "us-east-1"
46+
*/
3647
@param:DefaultValue("us-east-1") val region: Region
3748
)

0 commit comments

Comments
 (0)