Regular updates

[twpd/master.git] / rdoc.md

diff --git a/rdoc.md b/rdoc.md
index 76696f7..4caadf8 100644 (file)
--- a/rdoc.md
+++ b/rdoc.md
@@ -16,11 +16,42 @@ layout: 2017/sheet
 #
 # @param [String] param_name The xx and xx.
 #
-# @see http://url.com
+# @see https://example.com/
 #
 # @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
+```
+
+### Exceptions
+```rb
+# @raise [AccountBalanceError] if the account does not have
+#   sufficient funds to perform the transaction
+```
+
 ### Inline
 
 ```markdown
@@ -30,9 +61,15 @@ _emphasized_
 ```
 
 ```markdown
-http://www.link.com
+{ObjectName#method optional title}
+{Class::CONSTANT My constant's title}
+{#method_inside_current_namespace}
+```
+
+```markdown
+https://www.example.com/
 See Models::User@Examples
-{Google}[http://google.com]
+{Google}[https://google.com/]
 ```
 
 ### Skip
@@ -108,6 +145,7 @@ Place this at the beginning of the file.
 ## Also see
 {: .-one-column}
 
-* <http://rdoc.rubyforge.org/RDoc/Markup.html>
-* <http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md>
+* <https://docs.ruby-lang.org/en/2.1.0/RDoc/Markup.html>
+* <https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md>
+* <https://rubydoc.info/gems/yard/file/docs/Tags.md>
 {: .-also-see}