Skip to content

Commit 8aa2df1

Browse files
committed
Fixup yarddoc
1 parent 778138b commit 8aa2df1

File tree

1 file changed

+20
-25
lines changed

1 file changed

+20
-25
lines changed

lib/rex/proto/dcerpc/svcctl/packet.rb

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -62,23 +62,23 @@ def openscmanagerw(rhost, access = SC_MANAGER_ALL_ACCESS)
6262
# Calls CreateServiceW() to create a system service. Returns a handle to
6363
# the service on success, or nil.
6464
#
65-
# @param scm_handle [String] the SCM handle (from dce_openscmanagerw()).
65+
# @param scm_handle [String] the SCM handle (from {#openscmanagerw}).
6666
# @param service_name [String] the service name.
6767
# @param display_name [String] the display name.
6868
# @param binary_path [String] the path of the binary to run.
69-
# @param opts [Hash] a hash containing the following keys and values:
70-
# access [Fixnum] the access level (default is maximum).
71-
# type [Fixnum] the type of service (default is interactive,
72-
# own process).
73-
# start [Fixnum] the start options (default is on demand).
74-
# errors [Fixnum] the error options (default is ignore).
75-
# load_order_group [Fixnum] the load order group.
76-
# dependencies [Fixnum] the dependencies of the service.
77-
# service_start [Fixnum]
78-
# password1 [Fixnum]
79-
# password2 [Fixnum]
80-
# password3 [Fixnum]
81-
# password4 [Fixnum]
69+
# @param opts [Hash] arguments for CreateServiceW()
70+
# @option opts [Fixnum] :access (SERVICE_ALL_ACCESS) the access level.
71+
# @option opts [Fixnum] :type (SERVICE_WIN32_OWN_PROCESS ||
72+
# SERVICE_INTERACTIVE_PROCESS) the type of service.
73+
# @option opts [Fixnum] :start (SERVICE_DEMAND_START) the start options.
74+
# @option opts [Fixnum] :errors (SERVICE_ERROR_IGNORE) the error options.
75+
# @option opts [Fixnum] :load_order_group (0) the load order group.
76+
# @option opts [Fixnum] :dependencies (0) the dependencies of the service.
77+
# @option opts [Fixnum] :service_start (0)
78+
# @option opts [Fixnum] :password1 (0)
79+
# @option opts [Fixnum] :password2 (0)
80+
# @option opts [Fixnum] :password3 (0)
81+
# @option opts [Fixnum] :password4 (0)
8282
#
8383
# @return [String, Integer] a handle to the created service, windows
8484
# error code.
@@ -177,7 +177,7 @@ def closehandle(handle)
177177

178178
# Calls OpenServiceW to obtain a handle to an existing service.
179179
#
180-
# @param scm_handle [String] the SCM handle (from dce_openscmanagerw()).
180+
# @param scm_handle [String] the SCM handle (from {#openscmanagerw}).
181181
# @param service_name [String] the name of the service to open.
182182
# @param access [Fixnum] the level of access requested (default is maximum).
183183
#
@@ -204,8 +204,7 @@ def openservicew(scm_handle, service_name, access = SERVICE_ALL_ACCESS)
204204
# Calls StartService() on a handle to an existing service in order to start
205205
# it. Returns true on success, or false.
206206
#
207-
# @param svc_handle [String] the handle of the service to start (from
208-
# dce_openservicew()).
207+
# @param svc_handle [String] the handle of the service (from {#openservicew}).
209208
# @param magic1 [Fixnum] an unknown value.
210209
# @param magic2 [Fixnum] another unknown value.
211210
#
@@ -228,8 +227,7 @@ def startservice(svc_handle, magic1 = 0, magic2 = 0)
228227

229228
# Stops a running service.
230229
#
231-
# @param svc_handle [String] the handle of the service to stop (from
232-
# dce_openservicew()).
230+
# @param svc_handle [String] the handle of the service (from {#openservicew}).
233231
#
234232
# @return [Integer] Windows error code
235233
def stopservice(svc_handle)
@@ -238,8 +236,7 @@ def stopservice(svc_handle)
238236

239237
# Controls an existing service.
240238
#
241-
# @param svc_handle [String] the handle of the service to control
242-
# (from dce_openservicew()).
239+
# @param svc_handle [String] the handle of the service (from {#openservicew}).
243240
# @param operation [Fixnum] the operation number to perform (1 = stop
244241
# service; others are unknown).
245242
#
@@ -260,8 +257,7 @@ def controlservice(svc_handle, operation)
260257

261258
# Calls DeleteService() to delete a service.
262259
#
263-
# @param svc_handle [String] the handle of the service to delete (from
264-
# dce_openservicew()).
260+
# @param svc_handle [String] the handle of the service (from {#openservicew}).
265261
#
266262
# @return [Integer] Windows error code
267263
def deleteservice(svc_handle)
@@ -280,8 +276,7 @@ def deleteservice(svc_handle)
280276

281277
# Calls QueryServiceStatus() to query the status of a service.
282278
#
283-
# @param svc_handle [String] the handle of the service to query (from
284-
# dce_openservicew()).
279+
# @param svc_handle [String] the handle of the service (from {#openservicew}).
285280
#
286281
# @return [Fixnum] Returns 0 if the query failed (i.e.: a state was returned
287282
# that isn't implemented), 1 if the service is running, and

0 commit comments

Comments
 (0)