Browse Source

fix some yardoc issues

Christian Mehlmauer 3 years ago
parent
commit
3b280d45a4
No account linked to committer's email address

+ 1
- 1
lib/msf/base/serializer/json.rb View File

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

+ 0
- 1
lib/msf/base/simple/framework/module_paths.rb View File

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

+ 1
- 1
lib/msf/core/modules/loader/base.rb View File

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

+ 1
- 2
lib/msf/core/post/common.rb View File

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

+ 2
- 4
lib/msf/util/document_generator/normalizer.rb View File

@@ -173,8 +173,7 @@ module Msf
173 173
 
174 174
         # Returns the markdown format for module authors.
175 175
         #
176
-        # @param authors [Array] Module Authors
177
-        # @param authors [String] Module author
176
+        # @param authors [Array, String] Module Authors
178 177
         # @return [String]
179 178
         def normalize_authors(authors)
180 179
           if authors.kind_of?(Array)
@@ -205,8 +204,7 @@ module Msf
205 204
 
206 205
         # Returns the markdown format for module platforms.
207 206
         #
208
-        # @param platforms [Array] Module platforms.
209
-        # @param platforms [String] Module platform.
207
+        # @param platforms [Array, String] Module platforms.
210 208
         # @return [String]
211 209
         def normalize_platforms(platforms)
212 210
           if platforms.kind_of?(Array)

Loading…
Cancel
Save