Merge pull request #6 from Wescoeur/fix-code-documentation

SMB Create request code documentation.

lib/api/src/createWriteStream.js

@@ -52,7 +52,7 @@ class SmbWritableStream extends Writable {
       const offset = new Bigint(this.offset)
       this.offset = this.offset.add(packetSize)
 
-      const fiboGen = fibonacci()
+      const retryInterval = fibonacci()
       let pending = true
 
       while (pending) {
@@ -67,7 +67,7 @@ class SmbWritableStream extends Writable {
         } catch (error) {
           if (error.code === 'STATUS_PENDING') {
             await new Promise((resolve, reject) => {
-              setTimeout(resolve, fiboGen.next().value)
+              setTimeout(resolve, retryInterval.next().value)
             })
           } else {
             throw error

lib/messages/create.js

@@ -9,6 +9,8 @@ module.exports = message({
     var buffer = new Buffer(params.path, 'ucs2');
     var createDisposition = params.createDisposition
 
+    /* See: https://msdn.microsoft.com/en-us/library/cc246502.aspx
+       6 values for CreateDisposition. */
     if (!(createDisposition >= 0 && createDisposition <= 5)) {
       createDisposition = FILE_OVERWRITE_IF
     }

lib/structures/constants.js

+/* Documentation https://msdn.microsoft.com/en-us/library/cc246497.aspx */
+
 module.exports = {
+  /* 2.2.13 SMB2 CREATE Request:
+     https://msdn.microsoft.com/en-us/library/cc246502.aspx */
   FILE_SUPERSEDE: 0x00000000,
   FILE_OPEN: 0x00000001,
   FILE_CREATE: 0x00000002,