Skip to content

Commit 0dd987d

Browse files
committed
Updated as per jlee-r7 feedback
1 parent 27353d6 commit 0dd987d

File tree

7 files changed

+14
-17
lines changed

7 files changed

+14
-17
lines changed

lib/metasploit/framework/database.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module Database
2222
#
2323
# @param options [Hash{Symbol=>String}]
2424
# @option options [String] :path Path to use instead of first element of {configurations_pathnames}
25-
# @return [String] pathname if configuration pathname exists.
25+
# @return [Pathname] if configuration pathname exists.
2626
# @return [nil] if configuration pathname does not exist.
2727
def self.configurations_pathname(options={})
2828
options.assert_valid_keys(:path)

lib/msf/core/auxiliary/report.rb

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,11 @@ def get_host(opts)
113113

114114
#
115115
# Report a client connection
116-
#
117-
# opts must contain
118-
# :host the address of the client connecting
119-
# :ua_string a string that uniquely identifies this client
120-
# opts can contain
121-
# :ua_name a brief identifier for the client, e.g. "Firefox"
122-
# :ua_ver the version number of the client, e.g. "3.0.11"
116+
# @param opts [Hash] report client information based on user-agent
117+
# @option opts [String] :host the address of the client connecting
118+
# @option opts [String] :ua_string a string that uniquely identifies this client
119+
# @option opts [String] :ua_name a brief identifier for the client, e.g. "Firefox"
120+
# @option opts [String] :ua_ver the version number of the client, e.g. "3.0.11"
123121
#
124122
def report_client(opts={})
125123
return if not db

lib/msf/core/exploit/smb/client/psexec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def display_name
5252

5353
# Retrieve the SERVICE_DESCRIPTION option
5454
#
55-
# @return [String] service_description the service description.
55+
# @return [String] the service description.
5656
def service_description
5757
@service_description ||= datastore['SERVICE_DESCRIPTION']
5858
end

lib/msf/core/handler/reverse_http.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def payload_uri(req)
9999
"#{scheme}://#{callback_host}/"
100100
end
101101

102-
# Use the refname to determine whether this handler uses SSL or not
102+
# Use the {#refname} to determine whether this handler uses SSL or not
103103
#
104104
def ssl?
105105
!!(self.refname.index("https"))

lib/msf/core/post/windows/services.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ def service_restart(name, start_type=START_TYPE_AUTO, server=nil)
528528
# Parses out a SERVICE_STATUS struct from the
529529
# lpServiceStatus out parameter
530530
#
531-
# @param (lpServiceStatus) lpServiceStatus latest status of calling service
531+
# @param lpServiceStatus [String] the latest status of calling service
532532
#
533533
# @return [Hash] Containing SERVICE_STATUS values
534534
#

lib/msf/java/rmi/client.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,7 @@ def recv_return(opts = {})
109109

110110
# Helper method to read fragmented data from a ```Rex::Socket::Tcp```
111111
#
112-
# @param [Hash] nsock
113-
# @option [Rex::Socket::Tcp] sock
112+
# @param nsock [Rex::Socket::Tcp,#get_once]
114113
# @return [String]
115114
def safe_get_once(nsock = sock)
116115
data = ''

lib/rex/java/serialization/model/field.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ class Field < Element
1111
include Rex::Java::Serialization::Model::Contents
1212

1313
# @!attribute type
14-
# @return [String] The type of the field.
14+
# @return [String] The type of the field.
1515
attr_accessor :type
1616
# @!attribute name
17-
# @return [Rex::Java::Serialization::Model::Utf] The name of the field.
17+
# @return [Rex::Java::Serialization::Model::Utf] The name of the field.
1818
attr_accessor :name
1919
# @!attribute field_type
20-
# @return [Rex::Java::Serialization::Model::Utf] The type of the field on object types.
20+
# @return [Rex::Java::Serialization::Model::Utf] The type of the field on object types.
2121
attr_accessor :field_type
2222

2323
# @param stream [Rex::Java::Serialization::Model::Stream] the stream where it belongs to
@@ -32,7 +32,7 @@ def initialize(stream = nil)
3232
#
3333
# @param io [IO] the io to read from
3434
# @return [self] if deserialization succeeds
35-
# @return [RuntimeError] false if deserialization doesn't succeed
35+
# @raise [RuntimeError] if deserialization doesn't succeed
3636
def decode(io)
3737
code = io.read(1)
3838

0 commit comments

Comments
 (0)