Skip to content

Commit ba65ecc

Browse files
committed
Remove boilerplate docs
1 parent 3227e2e commit ba65ecc

File tree

1 file changed

+3
-44
lines changed

1 file changed

+3
-44
lines changed

plugins/fzuse.rb

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,7 @@
1414
end
1515

1616
module Msf
17-
###
18-
#
19-
# This class illustrates a fuzzy_use plugin. Plugins can change the behavior of
20-
# the framework by adding new features, new user interface commands, or
21-
# through any other arbitrary means. They are designed to have a very loose
22-
# definition in order to make them as useful as possible.
23-
#
24-
###
2517
class Plugin::FuzzyUse < Msf::Plugin
26-
27-
###
28-
#
29-
# This class implements a fuzzy_use console command dispatcher.
30-
#
31-
###
3218
class ConsoleCommandDispatcher
3319
include Msf::Ui::Console::CommandDispatcher
3420

@@ -56,9 +42,6 @@ def initialize(driver)
5642
@module_dispatcher = Msf::Ui::Console::CommandDispatcher::Modules.new(driver)
5743
end
5844

59-
#
60-
# The dispatcher's name.
61-
#
6245
def name
6346
'FuzzyUse'
6447
end
@@ -68,7 +51,7 @@ def name
6851
#
6952
def commands
7053
{
71-
'fzuse' => 'A fuzzy_use command added by the fuzzy_use plugin'
54+
'fzuse' => 'A fuzzy use command added by the FuzzyUse plugin'
7255
}
7356
end
7457

@@ -100,7 +83,7 @@ def pipe_server(socket_path)
10083
end
10184

10285
#
103-
# This method handles the fuzzy_use command.
86+
# This method handles the fzuse command.
10487
#
10588
def cmd_fzuse(*args)
10689
selection = nil
@@ -134,13 +117,6 @@ def cmd_fzuse(*args)
134117
end
135118
end
136119

137-
#
138-
# The constructor is called when an instance of the plugin is created. The
139-
# framework instance that the plugin is being associated with is passed in
140-
# the framework parameter. Plugins should call the parent constructor when
141-
# inheriting from Msf::Plugin to ensure that the framework attribute on
142-
# their instance gets set.
143-
#
144120
def initialize(framework, opts)
145121
super
146122

@@ -153,38 +129,21 @@ def initialize(framework, opts)
153129
return
154130
end
155131

156-
# If this plugin is being loaded in the context of a console application
157-
# that uses the framework's console user interface driver, register
158-
# console dispatcher commands.
159132
add_console_dispatcher(ConsoleCommandDispatcher)
160133

161134
print_status('FuzzyUse plugin loaded.')
162135
end
163136

164-
#
165-
# The cleanup routine for plugins gives them a chance to undo any actions
166-
# they may have done to the framework. For instance, if a console
167-
# dispatcher was added, then it should be removed in the cleanup routine.
168-
#
169137
def cleanup
170-
# If we had previously registered a console dispatcher with the console,
171-
# deregister it now.
172138
remove_console_dispatcher('FuzzyUse')
173139
end
174140

175-
#
176-
# This method returns a short, friendly name for the plugin.
177-
#
178141
def name
179142
'fuzzy_use'
180143
end
181144

182-
#
183-
# This method returns a brief description of the plugin. It should be no
184-
# more than 60 characters, but there are no hard limits.
185-
#
186145
def desc
187-
'Demonstrates using framework plugins'
146+
'A plugin offering a fuzzy use command'
188147
end
189148

190149
end

0 commit comments

Comments
 (0)