From 816d6bfa138f82a5d463c98b1f3bc99f5a71cab8 Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Thu, 14 Sep 2023 11:31:11 -0400 Subject: [PATCH] update docs --- .../software/amazon/smithy/kotlin/codegen/KotlinSettings.kt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/KotlinSettings.kt b/codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/KotlinSettings.kt index 4d5b8e18f..deae0e72d 100644 --- a/codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/KotlinSettings.kt +++ b/codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/KotlinSettings.kt @@ -197,6 +197,10 @@ class UnresolvableProtocolException(message: String) : CodegenException(message) private fun Optional.orNull(): T? = if (isPresent) get() else null +/** + * The visibility of code-generated classes, objects, interfaces, etc. + * Valid values are `public` and `internal`. `private` not supported because codegen would not compile with private classes. + */ enum class Visibility(val value: String) { PUBLIC("public"), INTERNAL("internal"), @@ -212,7 +216,7 @@ enum class Visibility(val value: String) { /** * Contains API settings for a Kotlin project - * @param visibility String representing the visibility of code-generated classes, objects, interfaces, etc. + * @param visibility Enum representing the visibility of code-generated classes, objects, interfaces, etc. */ data class ApiSettings( val visibility: Visibility = Visibility.PUBLIC,