Add withTransaction mention in the docs of each transaction-related m…

…ethod
joffrey-bion · Jun 4, 2024 · 3ca654e · 3ca654e
1 parent 4eefd2e
commit 3ca654e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/krossbow-stomp-core/src/commonMain/kotlin/org/hildan/krossbow/stomp/StompSession.kt b/krossbow-stomp-core/src/commonMain/kotlin/org/hildan/krossbow/stomp/StompSession.kt
@@ -149,16 +149,22 @@ interface StompSession {
 
     /**
      * Sends a BEGIN frame with the given [transactionId].
+     *
+     * @see withTransaction
      */
     suspend fun begin(transactionId: String)
 
     /**
      * Sends a COMMIT frame with the given [transactionId].
+     *
+     * @see withTransaction
      */
     suspend fun commit(transactionId: String)
 
     /**
      * Sends an ABORT frame with the given [transactionId].
+     *
+     * @see withTransaction
      */
     suspend fun abort(transactionId: String)