Add phpdoc ColumnSchema class. (#216)

terabytesoftw · web-flow · commit f6ff887bd76b · 2023-03-05T07:30:33.000-03:00
diff --git a/src/ColumnSchema.php b/src/ColumnSchema.php
@@ -6,6 +6,29 @@
 
 use Yiisoft\Db\Schema\AbstractColumnSchema;
 
+/**
+ * Represents the metadata of a column in a database table for SQLite Server. It provides information about the column's
+ * name, type, size, precision, and other details.
+ *
+ * Is used to store and retrieve metadata about a column in a database table. It is typically used in conjunction with
+ * the {@see TableSchema}, which represents the metadata of a database table as a whole.
+ *
+ * The following code shows how to use:
+ *
+ * ```php
+ * use Yiisoft\Db\Sqlite\ColumnSchema;
+ *
+ * $column = new ColumnSchema();
+ * $column->name('id');
+ * $column->allowNull(false);
+ * $column->dbType('integer');
+ * $column->phpType('integer');
+ * $column->type('integer');
+ * $column->defaultValue(0);
+ * $column->autoIncrement(true);
+ * $column->primaryKey(true);
+ * ```
+ */
 final class ColumnSchema extends AbstractColumnSchema
 {
 }
