Index: project_issue.install
===================================================================
RCS file: /cvs/drupal/contributions/modules/project_issue/project_issue.install,v
retrieving revision 1.55
diff -u -r1.55 project_issue.install
--- project_issue.install	20 Jan 2009 18:38:03 -0000	1.55
+++ project_issue.install	25 Jan 2009 14:21:16 -0000
@@ -6,62 +6,62 @@
  */
 function project_issue_schema() {
   $schema['project_issue_projects'] = array(
-    'description' => t('TODO'),
+    'description' => t("Table containing issue-related settings per project."),
     'fields' => array(
       'nid' => array(
-        'description' => t('TODO'),
+        'description' => t("Primary Key: The {project_projects}.nid of the project."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'issues' => array(
-        'description' => t('TODO'),
+        'description' => t("Boolean value indicating whether or not issue-tracking is enabled for this project."),
         'type' => 'int',
         'size' => 'tiny',
         'not null' => TRUE,
         'default' => 0,
       ),
       'components' => array(
-        'description' => t('TODO'),
+        'description' => t("A serialized array defining the components for this project."),
         'type' => 'text',
         'not null' => FALSE,
       ),
       'help' => array(
-        'description' => t('TODO'),
+        'description' => t("Submission guidelines for issues added to this project."),
         'type' => 'text',
         'not null' => FALSE,
       ),
       'mail_digest' => array(
-        'description' => t('TODO'),
+        'description' => t("E-mail address for the weekly critical issues report."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'mail_copy' => array(
-        'description' => t('TODO'),
+        'description' => t("E-mail address to send a copy of all issues to."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'mail_copy_filter' => array(
-        'description' => t('TODO'),
+        'description' => t("A serialized array containing the types of issues to include in the email."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'mail_copy_filter_state' => array(
-        'description' => t('TODO'),
+        'description' => t("A serialized array containing the statuses to include in the email."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'mail_reminder' => array(
-        'description' => t('TODO'),
+        'description' => t("Boolean indicating whether or not users with open issues should receive a monthly reminder."),
         'type' => 'int',
         'size' => 'tiny',
         'not null' => TRUE,
@@ -72,38 +72,38 @@
   );
 
   $schema['project_issues'] = array(
-    'description' => t('TODO'),
+    'description' => t("The base table for issues."),
     'fields' => array(
       'nid' => array(
-        'description' => t('TODO'),
+        'description' => t("Primary Key: The {node}.nid of this 'project_issue' node."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'pid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {project_projects}.nid of the project to which this issue belongs."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'category' => array(
-        'description' => t('TODO'),
+        'description' => t("Category of the issue."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'component' => array(
-        'description' => t('TODO'),
+        'description' => t("Component of the issue as defined on a project-by-project basis in {project_issue_projects}.components."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'priority' => array(
-        'description' => t('TODO'),
+        'description' => t("The priority for this issue."),
         'type' => 'int',
         'size' => 'tiny',
         'unsigned' => 1,
@@ -111,39 +111,39 @@
         'default' => 0,
       ),
       'rid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {project_release_nodes}.rid (version identifier) for this issue (only used in conjunction with the project_release module). References project_release_nodes."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'assigned' => array(
-        'description' => t('TODO'),
+        'description' => t("The {users}.uid of the user to which this issue is currently assigned."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'sid' => array(
-        'description' => t('TODO'),
+        'description' => t("Current {project_issue_state}.sid of this issue."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'original_issue_data' => array(
-        'description' => t('TODO'),
+        'description' => t("A serialized object containing the original values that were used when this issue was created."),
         'type' => 'text',
         'not null' => TRUE,
       ),
       'last_comment_id' => array(
-        'description' => t('TODO'),
+        'description' => t("{comments}.cid of the most recent comment added to the issue. 0 if no comment has been added yet."),
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
       ),
       'db_lock' => array(
-        'description' => t('TODO'),
+        'description' => t("Row-lock indicator to prevent race conditions when determining sequential comment number (http://drupal.org/node/180866)."),
         'type' => 'int',
         'size' => 'tiny',
         'not null' => TRUE,
@@ -159,77 +159,77 @@
   );
 
   $schema['project_issue_comments'] = array(
-    'description' => t('TODO'),
+    'description' => t("The base table for comments added to issues."),
     'fields' => array(
       'nid' => array(
-        'description' => t('TODO'),
+        'description' => t("References {project_issue}.nid, the issue to which this comment was added."),
         'type' => 'int',
         'not null' => FALSE,
       ),
       'cid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {comments}.cid for this comment."),
         'type' => 'int',
         'not null' => FALSE,
       ),
       'rid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {project_release_nodes}.rid (version identifier) after this comment was made (only used in conjunction with the project_release module)."),
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
       ),
       'component' => array(
-        'description' => t('TODO'),
+        'description' => t("Component of the issue after this comment was made. Components are defined on a project-by-project basis in {project_issue_projects}.components."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'category' => array(
-        'description' => t('TODO'),
+        'description' => t("Category of this issue after this comment was made."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
         'default' => '',
       ),
       'priority' => array(
-        'description' => t('TODO'),
+        'description' => t("The priority for this issue after this comment was made."),
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
       ),
       'assigned' => array(
-        'description' => t('TODO'),
+        'description' => t("The {users}.uid of the user to which this issue was assigned after this comment was made."),
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
       ),
       'sid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {project_issue_state}.sid of this issue after this comment was made."),
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
       ),
       'pid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {project_projects}.nid of the project to which this issue belongs after this comment was made."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'title' => array(
-        'description' => t('TODO'),
+        'description' => t("The title of the issue after this comment was made."),
         'type' => 'varchar',
         'length' => 255,
         'not null' => TRUE,
       ),
       'timestamp' => array(
-        'description' => t('TODO'),
+        'description' => t("Timestamp for this comment."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
       ),
       'comment_number' => array(
-        'description' => t('TODO'),
+        'description' => t("This comment's place in the list of comments for an issue."),
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
@@ -242,24 +242,24 @@
   );
 
   $schema['project_subscriptions'] = array(
-    'description' => t('TODO'),
+    'description' => t("Table keeping track of subscriptions per user per project for issue updates."),
     'fields' => array(
       'nid' => array(
-        'description' => t('TODO'),
+        'description' => t("{project_projects}.nid of the project to which the user is subscribed."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'uid' => array(
-        'description' => t('TODO'),
+        'description' => t("The {users}.uid for this subscriber."),
         'type' => 'int',
         'unsigned' => 1,
         'not null' => TRUE,
         'default' => 0,
       ),
       'level' => array(
-        'description' => t('TODO'),
+        'description' => t("The type of subscription. Possible values are: 0 = not subscribed, 1 = subscribed to own issues or 2 = subscribed to all issues."),
         'type' => 'int',
         'size' => 'tiny',
         'unsigned' => 1,
@@ -273,23 +273,23 @@
   );
 
   $schema['project_issue_state'] = array(
-    'description' => t('TODO'),
+    'description' => t("Table that holds all possible values for issue statuses."),
     'fields' => array(
       'sid' => array(
-        'description' => t('TODO'),
+        'description' => t("Primary Key: Unique id for this status."),
         'type' => 'serial',
         'unsigned' => 1,
         'not null' => TRUE,
       ),
       'name' => array(
-        'description' => t('TODO'),
+        'description' => t("Display-friendly name for this status."),
         'type' => 'varchar',
         'length' => 64,
         'not null' => TRUE,
         'default' => '',
       ),
       'weight' => array(
-        'description' => t('TODO'),
+        'description' => t("Weight for this status, used when ordering statuses"),
         'type' => 'int',
         'size' => 'tiny',
         'not null' => TRUE,
@@ -303,7 +303,7 @@
         'default' => 0,
       ),
       'default_query' => array(
-        'description' => t('TODO'),
+        'description' => t("Boolean indicating whether or not issues with this status are included in default queries."),
         'type' => 'int',
         'size' => 'tiny',
         'not null' => TRUE,
