aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoraditya-kapoor <aditya.kapoor@vinsol.com>2013-05-15 15:07:55 +0530
committeraditya-kapoor <aditya.kapoor@vinsol.com>2013-05-15 15:07:55 +0530
commitda8fff528ddcf3ea92f5c6cc402105e0403bb74a (patch)
treefc8b6002cb0f409e077616cff87026795820446d
parent0fbf31b2000e467f18ebba90efb3a88fa1a4a7c9 (diff)
downloadrails-da8fff528ddcf3ea92f5c6cc402105e0403bb74a.tar.gz
rails-da8fff528ddcf3ea92f5c6cc402105e0403bb74a.tar.bz2
rails-da8fff528ddcf3ea92f5c6cc402105e0403bb74a.zip
Added some more documentation for ActiveRecord::Associations::Builder::Association class
-rw-r--r--activerecord/lib/active_record/associations/builder/association.rb11
1 files changed, 11 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/associations/builder/association.rb b/activerecord/lib/active_record/associations/builder/association.rb
index 34684fd71a..456041cce8 100644
--- a/activerecord/lib/active_record/associations/builder/association.rb
+++ b/activerecord/lib/active_record/associations/builder/association.rb
@@ -1,6 +1,17 @@
# This is the parent Association class which defines certain class variables (valid_options) and
# instance variables (model, name, scope, options, reflection) which would be common across all the associations that we known today in Rails..
# Every association need to have the values of these variables set and they are used at multiple places
+# The heirarchy is defined as follows:
+# Association
+# - SingularAssociation
+# - BelongsTo
+# - HasOne
+# - CollectionAssociation
+# - HasMany
+# - HasAndBelongsToMany
+#
+# The HasMany :Through association is a special case of HasMany association with the :through option set for it
+#
module ActiveRecord::Associations::Builder
class Association #:nodoc: