fix some yardoc issues

bug/bundler_fix
Christian Mehlmauer 2016-04-18 21:00:21 +02:00
parent fd603102db
commit 3b280d45a4
No known key found for this signature in database
GPG Key ID: DCF54A05D6E62591
5 changed files with 5 additions and 9 deletions

View File

@ -14,7 +14,7 @@ module Msf
# the supplied module instance.
#
# @param mod [Msf::Module] the module to dump information for.
# @param indent [String] the indentation to use.
# @param _indent [String] the indentation to use.
# @return [String] formatted text output of the dump.
def self.dump_module(mod, _indent = "")
case mod.type

View File

@ -58,7 +58,6 @@ module Msf
# Extract directories `engine.paths['modules']` from `engine`.
#
# @param engine [Rails::Engine] a rails engine or application
# @param options [Hash] options for {Msf::ModuleManager::ModulePaths#add_module_paths}
# @return [Array<String>] The list of module paths to load
def extract_engine_module_paths(engine)
engine.paths['modules'] ? engine.paths['modules'].existent_directories : []

View File

@ -418,7 +418,7 @@ class Msf::Modules::Loader::Base
# Records the load warning to {Msf::ModuleManager::Loading#module_load_warnings} and the log.
#
# @param [String] module_path Path to the module as returned by {#module_path}.
# @param [String] Error message that caused the warning.
# @param [String] error Error message that caused the warning.
# @return [void]
#
# @see #module_path

View File

@ -57,7 +57,7 @@ module Msf::Post::Common
# For example: you can use a python meterpreter on a Windows platform, and you will
# get 'python/python' as your arch/platform, and not 'x86/win32'.
#
# @returns [String] The archtecture recognizable by framework's ARCH_TYPES.
# @return [String] The archtecture recognizable by framework's ARCH_TYPES.
def get_target_arch
arch = nil
@ -338,4 +338,3 @@ module Msf::Post::Common
end
end

View File

@ -173,8 +173,7 @@ module Msf
# Returns the markdown format for module authors.
#
# @param authors [Array] Module Authors
# @param authors [String] Module author
# @param authors [Array, String] Module Authors
# @return [String]
def normalize_authors(authors)
if authors.kind_of?(Array)
@ -205,8 +204,7 @@ module Msf
# Returns the markdown format for module platforms.
#
# @param platforms [Array] Module platforms.
# @param platforms [String] Module platform.
# @param platforms [Array, String] Module platforms.
# @return [String]
def normalize_platforms(platforms)
if platforms.kind_of?(Array)