Document Msf::Simple::Framework.simplify

MSP-11671
bug/bundler_fix
Luke Imhoff 2014-12-01 15:36:38 -06:00
parent 394d132d33
commit 57cabb4f10
No known key found for this signature in database
GPG Key ID: 5B1FB01FB33356F8
1 changed files with 9 additions and 0 deletions

View File

@ -74,9 +74,18 @@ module Framework
return simplify(framework, opts)
end
# @note If `opts['ConfigDirectory']` is set, then `Msf::Config::Defaults['ConfigDirectory']` will be updated to
# `opts['ConfigDirectory']`.
#
# Extends a framework object that may already exist.
#
# @param framework [Msf::Framework, Msf::Simple::Framework] framework to simplify
# @param opts [Hash{String => Object}]
# @option opts [#call] 'OnCreateProc' Proc to call after {#init_simplified}. Will be passed `framework`.
# @option opts [String] 'ConfigDirectory' Directory where configuration is saved. The `~/.msf4` directory.
# @option opts [Boolean] 'DisableLogging' (false) `true` to disable `Msf::Logging.init`
# @option opts [Boolean] 'DeferModuleLoads' (false) `true` to disable `framework.init_module_paths`.
# @return [Msf::Simple::Framework] `framework`
def self.simplify(framework, opts)
# If the framework instance has not already been extended, do it now.