From 8cf6fefe54f47e792cfd92c917c2c41d4523da7b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?G=C3=A1bor=20Hojtsy?= <gabor@hojtsy.hu>
Date: Wed, 10 Oct 2007 11:39:35 +0000
Subject: #164983 by multiple contributors: document the core database schemas

---
 modules/forum/forum.install | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

(limited to 'modules/forum/forum.install')

diff --git a/modules/forum/forum.install b/modules/forum/forum.install
index 71f606eb6..0b9ea5e87 100644
--- a/modules/forum/forum.install
+++ b/modules/forum/forum.install
@@ -56,10 +56,29 @@ function forum_uninstall() {
  */
 function forum_schema() {
   $schema['forum'] = array(
+    'description' => t('Stores the relationship of nodes to forum terms.'),
     'fields' => array(
-      'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
-      'vid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
-      'tid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0)
+      'nid' => array(
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => t('The {node}.nid of the node.'),
+      ),
+      'vid' => array(
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => t('Primary Key: The {node}.vid of the node.'),
+      ),
+      'tid' => array(
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => t('The {term_data}.tid of the forum term assigned to the node.'),
+      ),
     ),
     'indexes' => array(
       'nid' => array('nid'),
@@ -70,4 +89,3 @@ function forum_schema() {
 
   return $schema;
 }
-
-- 
cgit v1.2.3