Skip to content
This repository was archived by the owner on Oct 22, 2020. It is now read-only.

Commit 685a793

Browse files
committed
Correct various pieces of yardoc
1 parent 4b3f44a commit 685a793

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

lib/wpxf/core/payload.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def escape_single_quotes(val)
3636
end
3737

3838
# Generate a random variable name.
39-
# @return [String] a random name beetween 1 and 9 alpha characters.
39+
# @return [String] a random name beetween 5 and 20 alpha characters.
4040
def random_var_name
4141
Utility::Text.rand_alpha(rand(5..20))
4242
end

lib/wpxf/net/http_server.rb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,11 @@ def http_server_bind_port
4141
# @param path [String] the path requested.
4242
# @param params [Hash] the query string parameters.
4343
# @param headers [Hash] the HTTP headers.
44-
# @return [String] the response body to send to the client.
44+
# @return [String, Hash] if a string is returned, it will be used as the response body
45+
# to send to the client. If a {Hash} is returned, it should contain the keys:
46+
# * +:body+ - the body text of the response.
47+
# * +:type+ - the MIME type of the response.
48+
# * +:headers+ - a {Hash} of header keys and values.
4549
def on_http_request(path, params, headers)
4650
end
4751

lib/wpxf/wordpress/stored_xss.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def store_script
2424
raise 'Required method "store_script" has not been implemented'
2525
end
2626

27-
# Call #store_script and validate the response.
27+
# Call {store_script} and validate the response.
2828
# @return [Boolean] return true if the script was successfully stored.
2929
def store_script_and_validate
3030
res = store_script

0 commit comments

Comments
 (0)