106 lines
1.4 KiB
Markdown
106 lines
1.4 KiB
Markdown
---
|
|
title: Rdoc
|
|
category: Markup
|
|
layout: 2017/sheet
|
|
---
|
|
|
|
### Basic RDoc format
|
|
|
|
# Foo.
|
|
#
|
|
# @example
|
|
#
|
|
# y
|
|
# g
|
|
#
|
|
# @param [String] param_name The xx and xx.
|
|
#
|
|
# @see http://url.com
|
|
#
|
|
# @return [true] if so
|
|
|
|
### Inline
|
|
|
|
```
|
|
*bold*
|
|
_emphasized_
|
|
+code+
|
|
```
|
|
|
|
```
|
|
http://www.link.com
|
|
See Models::User@Examples
|
|
{Google}[http://google.com]
|
|
```
|
|
|
|
### Skip
|
|
|
|
```rb
|
|
def input # :nodoc:
|
|
```
|
|
|
|
```rb
|
|
module MyModule # :nodoc: all
|
|
```
|
|
|
|
### Definition lists
|
|
|
|
```
|
|
# == Definition lists
|
|
#
|
|
# list:: hi.
|
|
# +foo+:: parameterized
|
|
```
|
|
|
|
```
|
|
# == Definition lists
|
|
# [foo] also
|
|
# [bar] like this
|
|
```
|
|
|
|
### Return types
|
|
|
|
# @return [String]
|
|
# @return [String, nil] the name
|
|
|
|
### Callseq
|
|
|
|
# :call-seq:
|
|
# ARGF.readlines(sep=$/) -> array
|
|
# ARGF.readlines(limit) -> array
|
|
# ARGF.readlines(sep, limit) -> array
|
|
#
|
|
# ARGF.to_a(sep=$/) -> array
|
|
# ARGF.to_a(limit) -> array
|
|
# ARGF.to_a(sep, limit) -> array
|
|
|
|
### Category
|
|
|
|
# :category: Utilities
|
|
|
|
### Sections
|
|
|
|
```rb
|
|
# :section: Expiry methods
|
|
# methods relating to expiring
|
|
|
|
def expire!
|
|
def expired?
|
|
...
|
|
```
|
|
|
|
### Using tomdoc
|
|
|
|
```
|
|
# :markup: TomDoc
|
|
```
|
|
|
|
Plase 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>
|
|
{: .-also-see}
|