Preserve SQL create (pseudo)code in driver comments

diff --git a/imp/lib/Sentmail/Sql.php b/imp/lib/Sentmail/Sql.php
index dd34b43..93a114e 100644 (file)
--- a/imp/lib/Sentmail/Sql.php
+++ b/imp/lib/Sentmail/Sql.php
@@ -1,9 +1,25 @@
 <?php
 /**
- * IMP_Sentmail implementation for PHP's PEAR database abstraction layer.
+ * IMP_Sentmail implementation for SQL databases.
  *
- * The table structure can be created by the scripts/sql/imp_sentmail.sql
- * script.
+ * The table structure is as follows:
+ * <pre>
+ * CREATE TABLE imp_sentmail (
+ *     sentmail_id        BIGINT NOT NULL AUTO_INCREMENT,
+ *     sentmail_who       VARCHAR(255) NOT NULL,
+ *     sentmail_ts        BIGINT NOT NULL,
+ *     sentmail_messageid VARCHAR(255) NOT NULL,
+ *     sentmail_action    VARCHAR(32) NOT NULL,
+ *     sentmail_recipient VARCHAR(255) NOT NULL,
+ *     sentmail_success   INT NOT NULL,
+ *
+ *     PRIMARY KEY (sentmail_id)
+ * );
+ *
+ * CREATE INDEX sentmail_ts_idx ON imp_sentmail (sentmail_ts);
+ * CREATE INDEX sentmail_who_idx ON imp_sentmail (sentmail_who);
+ * CREATE INDEX sentmail_success_idx ON imp_sentmail (sentmail_success);
+ * </pre>
  *
  * Copyright 2010 The Horde Project (http://www.horde.org/)
  *