Skip to content

Commit 5a4c3a8

Browse files
committed
Merge pull request #2 from bcook-r7/land-5615-yard-docs
some doc fixes
2 parents 802e35f + 470779a commit 5a4c3a8

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

lib/msf/util/exe.rb

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ class EXE
2525
# Generates a default template
2626
#
2727
# @param opts [Hash] The options hash
28-
# @option opts [Hash] :template, the template type for the executable
29-
# @option opts [Hash] :template_path, the path for the template
30-
# @option opts [Hash] :fallback, If there are no options set, default options will be used
28+
# @option opts [String] :template, the template type for the executable
29+
# @option opts [String] :template_path, the path for the template
30+
# @option opts [Bool] :fallback, If there are no options set, default options will be used
3131
# @param exe [String] Template type. If undefined, will use the default.
3232
# @param path [String] Where you would like the template to be saved.
3333
def self.set_template_default(opts, exe = nil, path = nil)
@@ -66,7 +66,7 @@ def self.set_template_default(opts, exe = nil, path = nil)
6666
# self.read_replace_script_template
6767
#
6868
# @param filename [String] Name of the file
69-
# @param hash_sub [String]
69+
# @param hash_sub [Hash]
7070
def self.read_replace_script_template(filename, hash_sub)
7171
template_pathname = File.join(Msf::Config.data_directory, "templates",
7272
"scripts", filename)
@@ -77,8 +77,7 @@ def self.read_replace_script_template(filename, hash_sub)
7777

7878
# Executable generators
7979
#
80-
#
81-
# @param arch [String] The architecture of the system (i.e x86, x64)
80+
# @param arch [Array<String>] The architecture of the system (i.e :x86, :x64)
8281
# @param plat [String] The platform (i.e Linux, Windows, OSX)
8382
# @param code [String]
8483
# @param opts [Hash] The options hash
@@ -189,7 +188,7 @@ def self.clear_dynamic_base(exe, pe)
189188
# @option opts [String] :sub_method
190189
# @option opts [String] :inject, Code to inject into the exe
191190
# @option opts [String] :template
192-
# @option opts [String] :arch, Set to x86 by default
191+
# @option opts [Symbol] :arch, Set to :x86 by default
193192
# @return [String]
194193
def self.to_win32pe(framework, code, opts = {})
195194

@@ -932,7 +931,7 @@ def self.to_osx_app(exe, opts = {})
932931
# segments as writable and overwrites the entrypoint (usually _start) with
933932
# the payload.
934933
# @param framework [Msf::Framework] The framework of you want to use
935-
# @param opt [Hash]
934+
# @param opts [Hash]
936935
# @option [String] :template
937936
# @param template [String]
938937
# @param code [String]

0 commit comments

Comments
 (0)