Add docblocks to TableIndex

models/Schema/TableIndex.cfc

@@ -1,39 +1,119 @@
+/**
+* Represents an index or constraint in the schema.
+*/
 component accessors="true" {
 
+    /**
+    * The constraint type.
+    */
     property name="type";
+
+    /**
+    * The constraint name.
+    */
     property name="name";
+
+    /**
+    * The foreign key column
+    * For example, `country_id` referencing `countries`.`id`.
+    */
     property name="foreignKey";
+
+    /**
+    * The column or columns that make up the constraint.
+    */
     property name="columns";
+
+    /**
+    * The table the foreign key is referencing.
+    * For example, `countries` for a `country_id` column.
+    */
     property name="table";
-    property name="onUpdate" default="NONE";
-    property name="onDelete" default="NONE";
 
+    /**
+    * The strategy for updating foreign keys when the parent key is updated.
+    * Available values are:
+    * RESTRICT, CASCADE, SET NULL, NO ACTION, SET DEFAULT
+    */
+    property name="onUpdate" default="NO ACTION";
+
+    /**
+    * The strategy for updating foreign keys when the parent key is deleted.
+    * Available values are:
+    * RESTRICT, CASCADE, SET NULL, NO ACTION, SET DEFAULT
+    */
+    property name="onDelete" default="NO ACTION";
+
+    /**
+    * Create a new TableIndex instance.
+    *
+    * @returns A TableIndex instance.
+    */
     function init() {
         variables.columns = [];
         return this;
     }
 
+    /**
+    * Set the referencing column for a foreign key relationship.
+    * For example, `id` for a `country_id` column.
+    *
+    * @columns A column or array of columns that represents the foreign key reference.
+    *
+    * @returns The TableIndex instance.
+    */
     function references( columns ) {
         arguments.columns = isArray( columns ) ? columns : [ columns ];
         setColumns( columns );
         return this;
     }
 
+    /**
+    * Sets the referencing table for a foreign key relationship.
+    * For example, `countries` for a `country_id` column.
+    *
+    * @table   The referencing table name.
+    *
+    * @returns The TableIndex instance.
+    */
     function onTable( table ) {
         setTable( table );
         return this;
     }
 
-    function onDelete( option ) {
-        setOnDelete( option );
+    /**
+    * Set the strategy for updating foreign keys when the parent key is updated.
+    *
+    * @option  The strategy to use. Available values are:
+    *          RESTRICT, CASCADE, SET NULL, NO ACTION, SET DEFAULT
+    *
+    * @returns The TableIndex instance.
+    */
+    function onUpdate( option ) {
+        setOnUpdate( option );
         return this;
     }
 
-    function onCascade( option ) {
-        setOnCascade( option );
+    /**
+    * Set the strategy for updating foreign keys when the parent key is deleted.
+    *
+    * @option  The strategy to use. Available values are:
+    *          RESTRICT, CASCADE, SET NULL, NO ACTION, SET DEFAULT
+    *
+    * @returns The TableIndex instance.
+    */
+    function onDelete( option ) {
+        setOnDelete( option );
         return this;
     }
 
+    /**
+    * Set the column or columns that make up the constraint.
+    *
+    * @columns A single column or an array of columns that make up the constraint.
+    *
+    * @returns The TableIndex instance.
+    */
     function setColumns( columns ) {
         variables.columns = isArray( arguments.columns ) ? arguments.columns : [ arguments.columns ];
         return this;