From ee4ed02fa5e2daca5b828199fc562a9c8af874b8 Mon Sep 17 00:00:00 2001 From: "Rico Sta. Cruz" Date: Thu, 20 May 2021 11:57:24 +1000 Subject: [PATCH] Update rdoc.md --- rdoc.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/rdoc.md b/rdoc.md index 6639b2794..a1c23fc20 100644 --- a/rdoc.md +++ b/rdoc.md @@ -21,6 +21,31 @@ layout: 2017/sheet # @return [true] if so ``` +### Hash parameters + +```rb +# @param [Hash] opts the options to create a message with. +# @option opts [String] :subject The subject +# @option opts [String] :from ('nobody') From address +# @option opts [String] :to Recipient email +# @option opts [String] :body ('') The email's body +``` + +### Parameter types + +```rb +# @param (see User#initialize) +# @param [OptionParser] opts the option parser object +# @param [Array] args the arguments passed from input. This +# array will be modified. +# @param [Array] list the list of strings and symbols. +# @param [Hash] a hash with symbol keys and string values +# +# The options parsed out of the commandline. +# Default options are: +# :format => :dot +``` + ### Inline ```markdown