From 3b28636ff95180838de09adaa6f7c2dd036edacf Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Mon, 18 May 2009 14:25:53 +0000
Subject: - Patch #464912 by pwolanin: add doxygen suggestion standard for
 contrib module node build modes and similar int constants.

---
 modules/node/node.module | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'modules/node/node.module')

diff --git a/modules/node/node.module b/modules/node/node.module
index b6f6069b3..c79931f60 100644
--- a/modules/node/node.module
+++ b/modules/node/node.module
@@ -1241,6 +1241,21 @@ function node_prepare($node, $teaser = FALSE) {
 /**
  * Builds a structured array representing the node's content.
  *
+ * The content built for the node will vary depending on the $node->build_mode
+ * attribute.  The node module defines a set of common build mode constants:
+ *   - NODE_BUILD_NORMAL: Node is being built to be viewed normally.
+ *   - NODE_BUILD_PREVIEW: Node is being built to be previewed.
+ *   - NODE_BUILD_SEARCH_INDEX: Node is being built to be indexed for search.
+ *   - NODE_BUILD_SEARCH_RESULT: Node is being built as a search result.
+ *   - NODE_BUILD_RSS: Node is being built to be displayed in an RSS feed.
+ *
+ * The default mode is NODE_BUILD_NORMAL, which will be used if
+ * $node->build_mode is not set.
+ *
+ * When defining an additional build mode constant in a contributed module,
+ * the suggested standard is to use the unix timestamp of when you write the
+ * code to minimize the likelihood of two modules using the same value.
+ *
  * @param $node
  *   A node object.
  * @param $teaser
-- 
cgit v1.2.3