Fix Undocumentable method, missing name YARD warning

[#46491831]

Comments at the start of the file with ## caused YARD to think the
comment was documenting the require call.  By removing the ##, the
warning disappeared.  I did not determine what is special about ## in
file comments.

lib/msf/base.rb

@@ -1,5 +1,4 @@
 # -*- coding: binary -*-
-###
 #
 # framework-base
 # --------------
@@ -13,8 +12,6 @@
 # Beyond providing the default sessions, framework-base also provides
 # a wrapper interface to framework-core that makes some of the tasks,
 # such as exploitation, into easier to manage functions.
-#
-###
 
 # framework-base depends on framework-core
 require 'msf/core'

lib/msf/base/sessions/meterpreter.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base'
 require 'msf/base/sessions/scriptable'

lib/msf/base/sessions/meterpreter_java.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base/sessions/meterpreter'
 

lib/msf/base/sessions/meterpreter_options.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'shellwords'
 

lib/msf/base/sessions/meterpreter_php.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base/sessions/meterpreter'
 

lib/msf/base/sessions/meterpreter_x64_win.rb

@@ -1,7 +1,4 @@
 # -*- coding: binary -*-
-##
-# $Id: meterpreter_options.rb 10595 2010-10-08 04:11:47Z hdm $
-##
 
 require 'msf/base/sessions/meterpreter'
 require 'msf/windows_error'

lib/msf/base/sessions/meterpreter_x86_bsd.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base/sessions/meterpreter'
 

lib/msf/base/sessions/meterpreter_x86_linux.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base/sessions/meterpreter'
 

lib/msf/base/sessions/meterpreter_x86_win.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base/sessions/meterpreter'
 require 'msf/windows_error'

lib/msf/base/sessions/tty.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base'
 

lib/msf/base/simple/buffer.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base'
 

lib/msf/base/simple/payload.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base'
 

lib/msf/core/auxiliary/commandshell.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/base/sessions/command_shell_options'
 

lib/msf/core/auxiliary/web/form.rb

@@ -1,9 +1,7 @@
-##
 # This file is part of the Metasploit Framework and may be subject to
 # redistribution and commercial restrictions. Please see the Metasploit
 # Framework web site for more information on licensing and terms of use.
 # http://metasploit.com/framework/
-##
 
 require 'net/https'
 require 'net/http'

lib/msf/core/auxiliary/web/fuzzable.rb

@@ -1,9 +1,7 @@
-##
 # This file is part of the Metasploit Framework and may be subject to
 # redistribution and commercial restrictions. Please see the Metasploit
 # Framework web site for more information on licensing and terms of use.
 # http://metasploit.com/framework/
-##
 
 require 'net/https'
 require 'net/http'

lib/msf/core/auxiliary/web/path.rb

@@ -1,9 +1,7 @@
-##
 # This file is part of the Metasploit Framework and may be subject to
 # redistribution and commercial restrictions. Please see the Metasploit
 # Framework web site for more information on licensing and terms of use.
 # http://metasploit.com/framework/
-##
 
 require 'net/https'
 require 'net/http'

lib/msf/core/auxiliary/web/target.rb

@@ -1,9 +1,7 @@
-##
 # This file is part of the Metasploit Framework and may be subject to
 # redistribution and commercial restrictions. Please see the Metasploit
 # Framework web site for more information on licensing and terms of use.
 # http://metasploit.com/framework/
-##
 
 require 'net/https'
 require 'net/http'

lib/msf/core/exploit/browser_autopwn.rb

@@ -1,14 +1,10 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
-
-##
+#
 # This file is part of the Metasploit Framework and may be subject to
 # redistribution and commercial restrictions. Please see the Metasploit
 # Framework web site for more information on licensing and terms of use.
 # http://metasploit.com/framework/
-##
 
 require 'msf/core/auxiliary'
 

lib/msf/core/exploit/cmdstager.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/exploitation/cmdstager'
 require 'msf/core/exploit/exe'

lib/msf/core/exploit/cmdstager_debug_asm.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/core/exploit/cmdstager'
 

lib/msf/core/exploit/cmdstager_debug_write.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/core/exploit/cmdstager'
 

lib/msf/core/exploit/cmdstager_tftp.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/text'
 require 'msf/core/exploit/tftp'

lib/msf/core/exploit/cmdstager_vbs.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'msf/core/exploit/cmdstager'
 

lib/msf/core/exploit/cmdstager_vbs_adodb.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id: $
-##
 
 require 'msf/core/exploit/cmdstager'
 

lib/msf/core/exploit/dhcp.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/proto/dhcp'
 

lib/msf/core/exploit/tftp.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/proto/tftp'
 

lib/msf/ui/console/command_dispatcher/payload.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/parser/arguments'
 

lib/rex/exploitation/cmdstager.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/exploitation/cmdstager/base'
 require 'rex/exploitation/cmdstager/vbs'

lib/rex/exploitation/cmdstager/debug_asm.rb

@@ -1,7 +1,4 @@
 # -*- coding: binary -*-
-##
-# $Id: debug_asm.rb 12595 2011-05-12 18:33:49Z jduck $
-##
 
 require 'rex/text'
 require 'rex/arch'

lib/rex/exploitation/cmdstager/debug_write.rb

@@ -1,7 +1,4 @@
 # -*- coding: binary -*-
-##
-# $Id: debug_write.rb 12595 2011-05-12 18:33:49Z jduck $
-##
 
 require 'rex/text'
 require 'rex/arch'

lib/rex/exploitation/cmdstager/tftp.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/text'
 require 'rex/arch'

lib/rex/exploitation/cmdstager/vbs.rb

@@ -1,7 +1,4 @@
 # -*- coding: binary -*-
-##
-# $Id: vbs.rb 12595 2011-05-12 18:33:49Z jduck $
-##
 
 require 'rex/text'
 require 'rex/arch'

lib/rex/exploitation/jsobfu.rb

@@ -1,7 +1,5 @@
 # -*- coding: binary -*-
-##
 # $Id$
-##
 
 require 'rex/text'
 require 'rkelly'

lib/rex/proto/natpmp.rb

@@ -1,11 +1,7 @@
 # -*- coding: binary -*-
-##
-#
 # NAT-PMP protocol support
 #
-# by Jon Hart <jhart@spoofed.org>
-#
-##
+# @author Jon Hart <jhart@spoofed.org>
 
 require 'rex/proto/natpmp/constants'
 require 'rex/proto/natpmp/packet'

lib/rex/proto/ntlm/base.rb

@@ -40,17 +40,13 @@
 # The latter has a minor bug in its separate_keys function.
 # The third key has to begin from the 14th character of the
 # input string instead of 13th:)
-#--
-# $Id: ntlm.rb 11678 2011-01-30 19:26:35Z hdm $
-#++
-
-#this class defines the base type needed for other modules like message and crypt
 
 require 'rex/proto/ntlm/constants'
 
 module Rex
 module Proto
 module NTLM
+# The base type needed for other modules like message and crypt
 class Base
 
 CONST = Rex::Proto::NTLM::Constants

lib/rex/proto/rfb.rb

@@ -1,19 +1,13 @@
 # -*- coding: binary -*-
-##
 # $Id: $
-##
-
-##
 #
 # RFB protocol support
 #
-# by Joshua J. Drake <jduck>
+# @author Joshua J. Drake <jduck>
 #
 # Based on:
 # vnc_auth_none contributed by Matteo Cantoni <goony[at]nothink.org>
 # vnc_auth_login contributed by carstein <carstein.sec[at]gmail.com>
-#
-##
 
 require 'rex/proto/rfb/constants'
 require 'rex/proto/rfb/cipher'

lib/rex/proto/rfb.rb.ut.rb

@@ -1,23 +1,18 @@
 #!/usr/bin/env ruby
 # -*- coding: binary -*-
-
-$:.unshift(File.join(File.dirname(__FILE__), '..', '..'))
-
-##
+#
 # $Id: $
-##
-
-##
 #
 # RFB protocol support
 #
-# by Joshua J. Drake <jduck>
+# @author Joshua J. Drake <jduck>
 #
 # Based on:
 # vnc_auth_none contributed by Matteo Cantoni <goony[at]nothink.org>
 # vnc_auth_login contributed by carstein <carstein.sec[at]gmail.com>
 #
-##
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..'))
 
 require 'rex/socket'
 require 'rex/proto/rfb'