add some missing YARD docs

added YARD docs to the namespace modules MSP-12908
rapid7 · Jul 29, 2015 · 7800be4 · 7800be4
1 parent 7cdfd63
commit 7800be4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/lib/ruby_smb/smb1.rb b/lib/ruby_smb/smb1.rb
@@ -1,3 +1,5 @@
+# This module adds the namespace for version 1 of the SMB Protocol
+# as defined in [MS-SMB](https://msdn.microsoft.com/en-us/library/cc246231.aspx)
 module RubySMB::Smb1
   autoload :Packet, 'ruby_smb/smb1/packet'
 

diff --git a/lib/ruby_smb/smb1/packet.rb b/lib/ruby_smb/smb1/packet.rb
@@ -1,6 +1,7 @@
 require 'bit-struct'
 module RubySMB
   module Smb1
+    # This module holds the namespace for all SMB1 packets and related structures.
     module Packet
       autoload :SmbParameterBlock, 'ruby_smb/smb1/packet/smb_parameter_block'
     end