OSDN Git Service

Regular updates
authorErik <erikgronwal@users.osdn.me>
Thu, 20 May 2021 14:55:05 +0000 (23:55 +0900)
committerErik <erikgronwal@users.osdn.me>
Thu, 20 May 2021 14:55:05 +0000 (23:55 +0900)
rdoc.md

diff --git a/rdoc.md b/rdoc.md
index 6639b27..a1c23fc 100644 (file)
--- 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<String>] args the arguments passed from input. This
+#   array will be modified.
+# @param [Array<String, Symbol>] list the list of strings and symbols.
+# @param [Hash<Symbol, String>] a hash with symbol keys and string values
+#
+# The options parsed out of the commandline.
+# Default options are:
+#   :format => :dot
+```
+
 ### Inline
 
 ```markdown