<aside> <img src="attachment:a3a56fc3-c53c-47ff-aacc-d7c34f62abfd:table_of_content.png" alt="attachment:a3a56fc3-c53c-47ff-aacc-d7c34f62abfd:table_of_content.png" width="40px" />

TABLE OF CONTENT

</aside>

:ij-kt-annotation: Alpha


Package dev.tommasop1804.kutils.annotations
Since version 1.0.0
Retention Runtime
Target • Annotation class
• Class
• Constructor
• Field
• Function
• Local variable
• Property
• Property getter
• Property setter
• Type-Alias
• Value parameter
Opt-In level $\red\bullet\color{reset}\sf\ ERROR$
Other annotations :ij-kt-annotation: MustBeDocumented

Marks a component as being in the alpha stage of development. This designation implies that the component is still under development and may undergo significant changes before it becomes stable. Usage of components annotated with this marker should be limited to experimental or internal purposes, as compatibility is not guaranteed.

Properties

:ij-parameter: reason

Since version 1.0.0
Type String
Default Empty string

Explains the rationale for marking the component as alpha.

:ij-parameter: since

Since version 1.0.0
Type String
Default Empty string

Specifies the version since when this annotation or alpha component is applicable.

:ij-parameter: expectedBetaVersion

Since version 1.0.0
Type String
Default Empty string

Indicates the version when this component is expected to transition to beta.

Aspect

If the component marked with this annotation is used, a log of level WARN will be printed:

Function $method is annotated with @Alpha. Usage of this should be limited to experimental or internal purposes.

:ij-kt-annotation: Beta


Package dev.tommasop1804.kutils.annotations
Since version 1.0.0
Retention Runtime
Target • Annotation class
• Class
• Constructor
• Field
• Function
• Local variable
• Property
• Property getter
• Property setter
• Type-Alias
• Value parameter
Opt-In level $\color{yellow}\bullet\color{reset}\sf\ WARNING$
Other annotations :ij-kt-annotation: MustBeDocumented

Marks a component as being in the beta stage of development. This designation implies that the component is still under development and may undergo significant changes before it becomes stable. Usage of components annotated with this marker should be done with caution, as minor incompatibilities may still be introduced.

Properties

:ij-parameter: reason

Since version 1.0.0
Type String
Default Empty string

Explains the rationale for marking the component as beta.

:ij-parameter: since

Since version 1.0.0
Type String
Default Empty string

Specifies the version since when this annotation or betacomponent is applicable.

:ij-parameter: expectedStableVersion

Since version 1.0.0
Type String
Default Empty string

Indicates the version when this component is expected to transition to stable version.

Aspect