From c529e4afbece1355bee882500faf2fd0c059048a Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Mon, 26 May 2008 17:12:55 +0000
Subject: - Patch #101543 by webchick: document all constants.

---
 modules/node/node.module | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

(limited to 'modules/node')

diff --git a/modules/node/node.module b/modules/node/node.module
index 1003ebde5..9a64948cf 100644
--- a/modules/node/node.module
+++ b/modules/node/node.module
@@ -3,17 +3,46 @@
 
 /**
  * @file
- * The core that allows content to be submitted to the site. Modules and scripts may
- * programmatically submit nodes using the usual form API pattern.
+ * The core that allows content to be submitted to the site. Modules and
+ * scripts may programmatically submit nodes using the usual form API pattern.
  */
 
+/**
+ * Nodes changed before this time are always marked as read.
+ *
+ * Nodes changed after this time may be marked new, updated, or read, depending
+ * on their state for the current user. Defaults to 30 days ago.
+ */
 define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);
 
+/**
+ * Node is being built before being viewed normally.
+ */
 define('NODE_BUILD_NORMAL', 0);
+
+/**
+ * Node is being built before being previewed.
+ */
 define('NODE_BUILD_PREVIEW', 1);
+
+/**
+ * Node is being built before being indexed by search module.
+ */
 define('NODE_BUILD_SEARCH_INDEX', 2);
+
+/**
+ * Node is being built before being displayed as a search result.
+ */
 define('NODE_BUILD_SEARCH_RESULT', 3);
+
+/**
+ * Node is being built before being displayed as part of an RSS feed.
+ */
 define('NODE_BUILD_RSS', 4);
+
+/**
+ * Node is being built before being printed.
+ */
 define('NODE_BUILD_PRINT', 5);
 
 /**
-- 
cgit v1.2.3