commonMain.Parameterize.deprecated.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parameterize Show documentation

Kotlin DSL for clean parameterized code

The newest version!

/*
 * Copyright 2024 Ben Woodworth
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

@file:JvmMultifileClass
@file:JvmName("ParameterizeKt")

package com.benwoodworth.parameterize

import kotlin.jvm.JvmMultifileClass
import kotlin.jvm.JvmName

/**
 * Binary compatibility for [parameterize] after adding new options.
 *
 * When adding new arguments to [parameterize]:
 * - Copy the old [parameterize] signature to this file, marking it as deprecated and hidden,
 *   and have it delegate to the new [parameterize] function signature.
 * - Update the [ParameterizeConfiguration] spec:
 *     - Update the list of configuration options
 *     - Add a test for the option being applied
 *     - Add a test for the default behaviour
 * - Dump API, and confirm that the old signatures are the same (but with an added `synthetic` modifier)
 */
@Suppress("unused")
private const val binaryCompatibilityMessage = "Binary compatibility"