Cleanup docs

Author: egypt

lib/msf/core/exploit/http/client.rb

@@ -360,8 +360,9 @@ def send_request_raw(opts={}, timeout = 20)
   # Connects to the server, creates a request, sends the request,
   # reads the response
   #
-  # Passes +opts+ through directly to Rex::Proto::Http::Client#request_cgi.
+  # Passes `opts` through directly to {Rex::Proto::Http::Client#request_cgi}.
   #
+  # @return (see Rex::Proto::Http::Client#send_recv))
   def send_request_cgi(opts={}, timeout = 20)
     if datastore['HttpClientTimeout'] && datastore['HttpClientTimeout'] > 0
       actual_timeout = datastore['HttpClientTimeout']
@@ -401,14 +402,14 @@ def send_request_cgi(opts={}, timeout = 20)
     end
   end
 
+  # Connects to the server, creates a request, sends the request, reads the
+  # response if a redirect (HTTP 30x response) is received it will attempt to
+  # follow the direct and retrieve that URI.
   #
-  # Connects to the server, creates a request, sends the request, reads the response
-  # if a redirect (HTTP 30x response) is received it will attempt to follow the
-  # direct and retrieve that URI.
-  #
-  # @note The +opts+ will be updated to the updated location and +opts['redirect_uri']+
-  #   will contain the full URI.
+  # @note `opts` will be updated to the updated location and
+  #   `opts['redirect_uri']` will contain the full URI.
   #
+  # @return (see #send_request_cgi)
   def send_request_cgi!(opts={}, timeout = 20, redirect_depth = 1)
     if datastore['HttpClientTimeout'] && datastore['HttpClientTimeout'] > 0
       actual_timeout = datastore['HttpClientTimeout']