Changeset 9226 for trunk/activerecord/lib/active_record/reflection.rb

Timestamp:

04/05/08 03:52:58 (8 months ago)

Author:

pratik

Message:

Improve documentation.

Files:

• trunk/activerecord/lib/active_record/reflection.rb (modified) (1 diff)

trunk/activerecord/lib/active_record/reflection.rb

@@ -77 +77 @@
-      end
-
-, so it would return :balance for "composed_of :balance, :class_name => 'Money'" or
-:clients for "has_many :clients"
+.  For example, <tt>composed_of :balance, :class_name => 'Money'</tt> will return
+<tt>:balance</tt> or for <tt>has_many :clients</tt> it will return <tt>:clients</tt>
-      def name
-        @name
-      end
-
-type of the macro, so it would return :composed_of for
-"composed_of :balance, :class_name => 'Money'" or :has_many for "has_many :clients"
+macro type. For example, <tt>composed_of :balance, :class_name => 'Money'</tt> will return <tt>:composed_of</tt>
+or for <tt>has_many :clients</tt> will return <tt>:has_many</tt>
-      def macro
-        @macro
-      end
-
-
-
+
+
+
-      def options
-        @options
-      end
-
-, so "composed_of :balance, :class_name => 'Money'" returns the Money class and
-"has_many :clients" returns the Client
+.  For example, <tt>composed_of :balance, :class_name => 'Money'</tt> returns the +Money+
+class and <tt>has_many :clients</tt> returns the +Client+
-      def klass
-        @klass ||= class_name.constantize
-      end
-
+      # Returns the class name for the macro.  For example, <tt>composed_of :balance, :class_name => 'Money'</tt> returns <tt>'Money'</tt>
+      # and <tt>has_many :clients</tt> returns <tt>'Client'</tt>.
-      def class_name
-        @class_name ||= options[:class_name] || derive_class_name
-      end
-
+      # Returns +true+ if +self+ and +other_aggregation+ have the same +name+ attribute, +active_record+ attribute,
+      # and +other_aggregation+ has an options hash assigned to it.
-      def ==(other_aggregation)
-        name == other_aggregation.name && other_aggregation.options && active_record == other_aggregation.active_record