From 92887ca315d20d55959d950438b98e4c876fc57b Mon Sep 17 00:00:00 2001 From: Waseem Ahmad Date: Fri, 2 Mar 2012 01:28:30 +0530 Subject: Add documentation for IndexDefinition. --- .../active_record/connection_adapters/abstract/schema_definitions.rb | 3 +++ 1 file changed, 3 insertions(+) (limited to 'activerecord/lib/active_record/connection_adapters') diff --git a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb index ad2e8634eb..7ee8f40631 100644 --- a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb +++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb @@ -6,6 +6,9 @@ require 'bigdecimal/util' module ActiveRecord module ConnectionAdapters #:nodoc: + # Abstract representation of an index definition on a table. Instances of + # this type are typically created and returned by methods in database + # adapters. e.g. ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter#indexes class IndexDefinition < Struct.new(:table, :name, :unique, :columns, :lengths, :orders, :where) #:nodoc: end -- cgit v1.2.3