Skip to content

Commit 11d372b

Browse files
committed
Fix YARD documentation
* Thanks @void-in * See rapid7#5059
1 parent 02a5730 commit 11d372b

File tree

4 files changed

+7
-9
lines changed

4 files changed

+7
-9
lines changed

lib/msf/java/rmi/client.rb

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

120120
# Helper method to read fragmented data from a ```Rex::Socket::Tcp```
121121
#
122-
# @param opts [Hash]
123-
# @option opts [Rex::Socket::Tcp] :sock
122+
# @param nsock [Rex::Socket::Tcp]
124123
# @return [String]
125124
def safe_get_once(nsock = sock)
126125
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-
# @faise [RuntimeError] if deserialization doesn't succeed
35+
# @false [RuntimeError] if deserialization doesn't succeed
3636
def decode(io)
3737
code = io.read(1)
3838

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,7 @@ def decode_value(io)
190190

191191
# Serializes an NewArray value
192192
#
193-
# @param value [Fixnum] the value to serialize
194-
# @param value [Float] the value to serialize
193+
# @param value [<Fixnum, Float>] the value to serialize
195194
# @return [String] the serialized value
196195
# @raise [RuntimeError] if serialization fails
197196
def encode_value(value)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def encode
6363

6464
# Adds an element to the references array
6565
#
66-
# @param io [Rex::Java::Serialization::Model::Element] the object to save as reference dst
66+
# @param ref [Rex::Java::Serialization::Model::Element] the object to save as reference dst
6767
def add_reference(ref)
6868
self.references.push(ref)
6969
end

0 commit comments

Comments
 (0)