1
0
mirror of https://github.com/onkelbeh/cheatsheets.git synced 2025-10-16 23:47:47 +02:00
cheatsheets/rdoc.md
Rico Sta. Cruz 85cc0fe827 Hello.
2012-03-16 14:15:50 +08:00

422 B

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