From 40bdd44ce800932f41e0fc584881385e904c7953 Mon Sep 17 00:00:00 2001
From: InsanusMokrassar <ovsyannikov.alexey95@gmail.com>
Date: Mon, 4 Nov 2019 13:46:11 +0600
Subject: [PATCH] add small docs for WritePostsAPI

---
 .../postssystem/core/post/api/WritePostsAPI.kt                | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/core/src/main/kotlin/com/insanusmokrassar/postssystem/core/post/api/WritePostsAPI.kt b/core/src/main/kotlin/com/insanusmokrassar/postssystem/core/post/api/WritePostsAPI.kt
index 992f79fd..a2979f8d 100644
--- a/core/src/main/kotlin/com/insanusmokrassar/postssystem/core/post/api/WritePostsAPI.kt
+++ b/core/src/main/kotlin/com/insanusmokrassar/postssystem/core/post/api/WritePostsAPI.kt
@@ -9,6 +9,10 @@ interface WritePostsAPI {
     val postDeletedFlow: Flow<RegisteredPost>
     val postUpdatedFlow: Flow<RegisteredPost>
 
+    /**
+     * For creating of post you need to create all its [com.insanusmokrassar.postssystem.core.content.RegisteredContent]
+     * and (or just) retrieve their [ContentIds] and put it into some [Post] implementation line [SimplePost]
+     */
     suspend fun createPost(post: Post): RegisteredPost?
     suspend fun deletePost(id: PostId): Boolean