Skip to content

Commit

Permalink
Update rdoc.md (#1832)
Browse files Browse the repository at this point in the history
Co-authored-by: Rico Sta. Cruz <[email protected]>
  • Loading branch information
cbliard and rstacruz authored May 19, 2022
1 parent f142dce commit e7d44f5
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion rdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ layout: 2017/sheet
# @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
# @option opts [String] :body ('') The email's body
```
### Parameter types
Expand All @@ -46,6 +46,12 @@ layout: 2017/sheet
# :format => :dot
```

### Exceptions
```rb
# @raise [AccountBalanceError] if the account does not have
# sufficient funds to perform the transaction
```
### Inline
```markdown
Expand All @@ -54,6 +60,12 @@ _emphasized_
+code+
```

```markdown
{ObjectName#method optional title}
{Class::CONSTANT My constant's title}
{#method_inside_current_namespace}
```

```markdown
https://www.example.com/
See Models::User@Examples
Expand Down Expand Up @@ -135,4 +147,5 @@ Place this at the beginning of the file.

* <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}

0 comments on commit e7d44f5

Please sign in to comment.