aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/abstract_controller/helpers.rb
diff options
context:
space:
mode:
authorJoost Baaij <joost@spacebabies.nl>2010-08-25 18:57:27 +0200
committerJoost Baaij <joost@spacebabies.nl>2010-08-25 18:57:27 +0200
commiteaeda503e89ac7f182d9a43a1917f5cc852cdb14 (patch)
tree3f21968b694cd33e4a55885ffd0c953ec8ee6a92 /actionpack/lib/abstract_controller/helpers.rb
parent111c4a4a018e457fffd472df9a68a4625c4654e0 (diff)
downloadrails-eaeda503e89ac7f182d9a43a1917f5cc852cdb14.tar.gz
rails-eaeda503e89ac7f182d9a43a1917f5cc852cdb14.tar.bz2
rails-eaeda503e89ac7f182d9a43a1917f5cc852cdb14.zip
change rdoc to conform to api guidelines
Diffstat (limited to 'actionpack/lib/abstract_controller/helpers.rb')
-rw-r--r--actionpack/lib/abstract_controller/helpers.rb12
1 files changed, 6 insertions, 6 deletions
diff --git a/actionpack/lib/abstract_controller/helpers.rb b/actionpack/lib/abstract_controller/helpers.rb
index 4374b439d0..0c96a6ed15 100644
--- a/actionpack/lib/abstract_controller/helpers.rb
+++ b/actionpack/lib/abstract_controller/helpers.rb
@@ -40,7 +40,7 @@ module AbstractController
# <% if logged_in? -%>Welcome, <%= current_user.name %><% end -%>
#
# ==== Parameters
- # meths<Array[#to_s]>:: The name of a method on the controller
+ # * <tt>method[, method]</tt> - A name or names of a method on the controller
# to be made available on the view.
def helper_method(*meths)
meths.flatten.each do |meth|
@@ -55,8 +55,8 @@ module AbstractController
# The +helper+ class method can take a series of helper module names, a block, or both.
#
# ==== Parameters
- # *args<Array[Module, Symbol, String, :all]>
- # block<Block>:: A block defining helper methods
+ # * <tt>*args</tt> - Module, Symbol, String, :all
+ # * <tt>block</tt> - A block defining helper methods
#
# ==== Examples
# When the argument is a module it will be included directly in the template class.
@@ -100,7 +100,7 @@ module AbstractController
# rendered through this controller.
#
# ==== Parameters
- # mod<Module>:: The module to include into the current helper module
+ # * <tt>module</tt> - The module to include into the current helper module
# for the class
def add_template_helper(mod)
_helpers.module_eval { include mod }
@@ -118,10 +118,10 @@ module AbstractController
# are returned.
#
# ==== Parameters
- # args<Array[String, Symbol, Module]>:: A list of helpers
+ # * <tt>args</tt> - An array of helpers
#
# ==== Returns
- # Array[Module]:: A normalized list of modules for the list of
+ # * <tt>Array</tt> - A normalized list of modules for the list of
# helpers provided.
def modules_for_helpers(args)
args.flatten.map! do |arg|