29 lines
422 B
Markdown
29 lines
422 B
Markdown
title: Rdoc
|
|
----
|
|
|
|
### Basic RDoc format
|
|
|
|
# Foo.
|
|
#
|
|
# @example
|
|
#
|
|
# y
|
|
# g
|
|
#
|
|
# @param [String] param_name The xx and xx.
|
|
#
|
|
# @see http://url.com
|
|
#
|
|
# @return [true] if so
|
|
#
|
|
# == Definition lists
|
|
#
|
|
# list:: hi.
|
|
# +foo+:: parameterized
|
|
#
|
|
# == Definition lists
|
|
# [foo] also
|
|
# [bar] like this
|
|
|
|
http://rdoc.rubyforge.org/RDoc/Markup.html
|