add documentation and arguments to walk

1 files changed, 7 insertions, 1 deletions

diff --git a/src/main/kotlin/ProtocolTranslator.kt b/src/main/kotlin/ProtocolTranslator.kt
index e938224..82c530a 100644
--- a/src/main/kotlin/ProtocolTranslator.kt
+++ b/src/main/kotlin/ProtocolTranslator.kt
@@ -43,8 +43,14 @@ interface ProtocolTranslator {
 
     /**
      * Descend a directory hierarchy.
+     *
+     * @param fid The existing FID. It must represent a directory.
+     * @param newfid The proposed FID, which is going to be associated with the result of walking the hierarchy. It must
+     * be not in use, unless it is the same as [fid].
+     * @param wname The successive path name elements which describe the file to walk to.
+     * @return a possible error.
      */
-    fun walk(path: String)
+    fun walk(fid: UInt, newfid: UInt, wname: List<String>): String?
 
     /**
      * Prepare an FID for I/O on an existing file.