add documentation and arguments to version method from NinePTranslator

1 files changed, 11 insertions, 1 deletions

diff --git a/src/main/kotlin/NinePTranslator.kt b/src/main/kotlin/NinePTranslator.kt
index c976cd9..0bbcb9d 100644
--- a/src/main/kotlin/NinePTranslator.kt
+++ b/src/main/kotlin/NinePTranslator.kt
@@ -12,8 +12,18 @@ TODO:
 interface NinePTranslator {
     /**
      * Negotiate protocol version.
+     *
+     * This must be the first message sent on the 9P connection and no other requests can be issued until a response has
+     * been received.
+     * Tag should be NOTAG ((ushort)~0).
+     *
+     * @param tag Should be NOTAG ((ushort)~0).
+     * @param msize The maximum length, in bytes, that the client will ever generate or expect to receive in a single
+     *              9P message.
+     * @param version Should be "9P2000", which is the only defined value.
+     * @return a possible error.
      */
-    fun version()
+    fun version(tag: SizedMessageField, msize: SizedMessageField, version: String): String?
 
     /**
      * Perform authentication.