Skip to content

Commit

Permalink
Doc fixes
Browse files Browse the repository at this point in the history 
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@4538 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information
@dhh
dhh committed Jul 5, 2006
1 parent 5326274 commit f384622
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 43 deletions.
79 changes: 39 additions & 40 deletions actionpack/lib/action_view/helpers/java_script_macros_helper.rb
View file
Expand Up @@ -27,7 +27,6 @@ module JavaScriptMacrosHelper
# <tt>:url</tt>:: Specifies the url where the updated value should # <tt>:url</tt>:: Specifies the url where the updated value should
# be sent after the user presses "ok". # be sent after the user presses "ok".
# #
#
# Addtional +options+ are: # Addtional +options+ are:
# <tt>:rows</tt>:: Number of rows (more than 1 will use a TEXTAREA) # <tt>:rows</tt>:: Number of rows (more than 1 will use a TEXTAREA)
# <tt>:cols</tt>:: Number of characters the text input should span (works for both INPUT and TEXTAREA) # <tt>:cols</tt>:: Number of characters the text input should span (works for both INPUT and TEXTAREA)
Expand Down Expand Up @@ -79,57 +78,57 @@ def in_place_editor_field(object, method, tag_options = {}, in_place_editor_opti
# Adds AJAX autocomplete functionality to the text input field with the # Adds AJAX autocomplete functionality to the text input field with the
# DOM ID specified by +field_id+. # DOM ID specified by +field_id+.
# #
# This function expects that the called action returns a HTML <ul> list, # This function expects that the called action returns an HTML <ul> list,
# or nothing if no entries should be displayed for autocompletion. # or nothing if no entries should be displayed for autocompletion.
# #
# You'll probably want to turn the browser's built-in autocompletion off, # You'll probably want to turn the browser's built-in autocompletion off,
# so be sure to include a autocomplete="off" attribute with your text # so be sure to include an <tt>autocomplete="off"</tt> attribute with your text
# input field. # input field.
# #
# The autocompleter object is assigned to a Javascript variable named <tt>field_id</tt>_auto_completer. # The autocompleter object is assigned to a Javascript variable named <tt>field_id</tt>_auto_completer.
# This object is useful if you for example want to trigger the auto-complete suggestions through # This object is useful if you for example want to trigger the auto-complete suggestions through
# other means than user input (for that specific case, call the <tt>activate</tt> method on that object). # other means than user input (for that specific case, call the <tt>activate</tt> method on that object).
# #
# Required +options+ are: # Required +options+ are:
# <tt>:url</tt>:: URL to call for autocompletion results # <tt>:url</tt>:: URL to call for autocompletion results
# in url_for format. # in url_for format.
# #
# Addtional +options+ are: # Addtional +options+ are:
# <tt>:update</tt>:: Specifies the DOM ID of the element whose # <tt>:update</tt>:: Specifies the DOM ID of the element whose
# innerHTML should be updated with the autocomplete # innerHTML should be updated with the autocomplete
# entries returned by the AJAX request. # entries returned by the AJAX request.
# Defaults to field_id + '_auto_complete' # Defaults to <tt>field_id</tt> + '_auto_complete'
# <tt>:with</tt>:: A JavaScript expression specifying the # <tt>:with</tt>:: A JavaScript expression specifying the
# parameters for the XMLHttpRequest. This defaults # parameters for the XMLHttpRequest. This defaults
# to 'fieldname=value'. # to 'fieldname=value'.
# <tt>:frequency</tt>:: Determines the time to wait after the last keystroke # <tt>:frequency</tt>:: Determines the time to wait after the last keystroke
# for the AJAX request to be initiated. # for the AJAX request to be initiated.
# <tt>:indicator</tt>:: Specifies the DOM ID of an element which will be # <tt>:indicator</tt>:: Specifies the DOM ID of an element which will be
# displayed while autocomplete is running. # displayed while autocomplete is running.
# <tt>:tokens</tt>:: A string or an array of strings containing # <tt>:tokens</tt>:: A string or an array of strings containing
# separator tokens for tokenized incremental # separator tokens for tokenized incremental
# autocompletion. Example: <tt>:tokens => ','</tt> would # autocompletion. Example: <tt>:tokens => ','</tt> would
# allow multiple autocompletion entries, separated # allow multiple autocompletion entries, separated
# by commas. # by commas.
# <tt>:min_chars</tt>:: The minimum number of characters that should be # <tt>:min_chars</tt>:: The minimum number of characters that should be
# in the input field before an Ajax call is made # in the input field before an Ajax call is made
# to the server. # to the server.
# <tt>:on_hide</tt>:: A Javascript expression that is called when the # <tt>:on_hide</tt>:: A Javascript expression that is called when the
# autocompletion div is hidden. The expression # autocompletion div is hidden. The expression
# should take two variables: element and update. # should take two variables: element and update.
# Element is a DOM element for the field, update # Element is a DOM element for the field, update
# is a DOM element for the div from which the # is a DOM element for the div from which the
# innerHTML is replaced. # innerHTML is replaced.
# <tt>:on_show</tt>:: Like on_hide, only now the expression is called # <tt>:on_show</tt>:: Like on_hide, only now the expression is called
# then the div is shown. # then the div is shown.
# <tt>:after_update_element</tt>:: A Javascript expression that is called when the # <tt>:after_update_element</tt>:: A Javascript expression that is called when the
# user has selected one of the proposed values. # user has selected one of the proposed values.
# The expression should take two variables: element and value. # The expression should take two variables: element and value.
# Element is a DOM element for the field, value # Element is a DOM element for the field, value
# is the value selected by the user. # is the value selected by the user.
# <tt>:select</tt>:: Pick the class of the element from which the value for # <tt>:select</tt>:: Pick the class of the element from which the value for
# insertion should be extracted. If this is not specified, # insertion should be extracted. If this is not specified,
# the entire element is used. # the entire element is used.
def auto_complete_field(field_id, options = {}) def auto_complete_field(field_id, options = {})
function = "var #{field_id}_auto_completer = new Ajax.Autocompleter(" function = "var #{field_id}_auto_completer = new Ajax.Autocompleter("
function << "'#{field_id}', " function << "'#{field_id}', "
Expand Down
6 changes: 3 additions & 3 deletions activerecord/lib/active_record/associations.rb
View file
Expand Up @@ -1248,7 +1248,7 @@ def create_extension_module(association_id, extension)
extension_module_name.constantize extension_module_name.constantize
end end


class JoinDependency class JoinDependency # :nodoc:
attr_reader :joins, :reflections, :table_aliases attr_reader :joins, :reflections, :table_aliases


def initialize(base, associations, joins) def initialize(base, associations, joins)
Expand Down Expand Up @@ -1348,7 +1348,7 @@ def construct_association(record, join, row)
return association return association
end end


class JoinBase class JoinBase # :nodoc:
attr_reader :active_record, :table_joins attr_reader :active_record, :table_joins
delegate :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record delegate :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record


Expand Down Expand Up @@ -1393,7 +1393,7 @@ def instantiate(row)
end end
end end


class JoinAssociation < JoinBase class JoinAssociation < JoinBase # :nodoc:
attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
delegate :options, :klass, :through_reflection, :source_reflection, :to => :reflection delegate :options, :klass, :through_reflection, :source_reflection, :to => :reflection


Expand Down

0 comments on commit f384622

Please sign in to comment.