add kdoc to SpecialContent and Content
This commit is contained in:
parent
eae3212c01
commit
2c9e615ea6
@ -2,8 +2,16 @@ package com.insanusmokrassar.postssystem.core.content
|
|||||||
|
|
||||||
typealias ContentId = String
|
typealias ContentId = String
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Content which is planned to be registered in database
|
||||||
|
*/
|
||||||
interface Content
|
interface Content
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Content which is already registered in database. Using its [id] you can retrieve all known
|
||||||
|
* [com.insanusmokrassar.postssystem.core.post.RegisteredPost]s by using
|
||||||
|
* [com.insanusmokrassar.postssystem.core.api.ReadPostsAPI.getPostsByContent]
|
||||||
|
*/
|
||||||
interface RegisteredContent : Content {
|
interface RegisteredContent : Content {
|
||||||
val id: ContentId
|
val id: ContentId
|
||||||
}
|
}
|
||||||
|
@ -2,10 +2,20 @@ package com.insanusmokrassar.postssystem.core.content
|
|||||||
|
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Special content, which usually better known in some plugin or system, but is not representable in others. For
|
||||||
|
* example, it could be issue in some git system, which is unknown for all other systems.
|
||||||
|
*
|
||||||
|
* @property internalId Represent Id of this content in system which knows exact type and can correctly handle this
|
||||||
|
* content
|
||||||
|
*/
|
||||||
interface SpecialContent : Content {
|
interface SpecialContent : Content {
|
||||||
val internalId: ContentId
|
val internalId: ContentId
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* As [SpecialContent], but already registered in posts system
|
||||||
|
*/
|
||||||
interface SpecialRegisteredContent : RegisteredContent, SpecialContent
|
interface SpecialRegisteredContent : RegisteredContent, SpecialContent
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
|
Loading…
Reference in New Issue
Block a user