Ajax docing #1282 [Dee.Zsombor@gmail.com]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@1318 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 13 insertions, 0 deletions

diff --git a/actionpack/lib/action_view/helpers/javascript_helper.rb b/actionpack/lib/action_view/helpers/javascript_helper.rb
index 35a09b2e4e..c897c5e8b8 100644
--- a/actionpack/lib/action_view/helpers/javascript_helper.rb
+++ b/actionpack/lib/action_view/helpers/javascript_helper.rb
@@ -67,6 +67,19 @@ module ActionView
       # If you for some reason or another need synchronous processing (that'll
       # block the browser while the request is happening), you can specify 
       # <tt>options[:type] = :synchronous</tt>.
+      #
+      # You can customize further browser side call logic by passing
+      # in Javascript code snippets via some optional parameters. In
+      # their order of use these are:
+      #
+      # <tt>:confirm</tt>::      Adds confirmation dialog.
+      # <tt>:condition</tt>::    Perform remote request conditionally
+      #                          by this expression. Use this to
+      #                          describe browser-side conditions when
+      #                          request should not be initiated.
+      # <tt>:before</tt>::       Called before request is initiated.
+      # <tt>:after</tt>::        Called immediately after request was
+      #                          initiated and before <tt>:loading</tt>.
       def link_to_remote(name, options = {}, html_options = {})  
         link_to_function(name, remote_function(options), html_options)
       end