StarOpenSource/Engine
StarOpenSource/Engine
2
0
Fork 1
Code Issues 11 Pull requests Releases 10 Activity Actions

Add NonKotlinContact annotation

Browse source
This commit is contained in:
JeremyStar™ 2024-12-15 01:09:58 +01:00
parent e76b0e72ff
commit 1e40c8b121
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
2 changed files with 75 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
base/src/main/kotlin/de/staropensource/engine/base/annotation/NonKotlinContact.kt Normal file
View file

@ -0,0 +1,49 @@
/*
* STAROPENSOURCE ENGINE SOURCE FILE
* Copyright (c) 2024 The StarOpenSource Engine Authors
* Licensed under the GNU Affero General Public License v3
* with an exception allowing classpath linking.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package de.staropensource.engine.base.annotation
/**
* Marks contacts with classes or code in other
* programming languages besides Kotlin in
* the public API.
*
* Using anything non-Kotlin in conjunction with
* the StarOpenSource Engine is highly discouraged,
* as the engine may be multiplatform in future
* releases and will not support using other
* languages.
*
* Using anything in contact with non-Kotlin code
* is therefore deemed unsafe and should be
* avoided at all costs. Only use methods and
* variables interacting with non-Kotlin stuff
* if absolutely necessary.
*
* @since v1-alpha10
*/
@Target(
AnnotationTarget.TYPE_PARAMETER,
AnnotationTarget.VALUE_PARAMETER,
AnnotationTarget.TYPE,
)
@Retention(AnnotationRetention.RUNTIME)
@MustBeDocumented
annotation class NonKotlinContact

26
base/src/main/kotlin/de/staropensource/engine/base/annotation/package-info.kt Normal file
View file

@ -0,0 +1,26 @@
/*
* STAROPENSOURCE ENGINE SOURCE FILE
* Copyright (c) 2024 The StarOpenSource Engine Authors
* Licensed under the GNU Affero General Public License v3
* with an exception allowing classpath linking.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* Annotations used by the engine and subsystems.
*
* @since v1-alpha10
*/
package de.staropensource.engine.base.annotation;