From 09e48b91b4cc02732bb361ab9edce87d3740a4a5 Mon Sep 17 00:00:00 2001
From: barrett <barrett@52745.no-reply.drupal.org>
Date: Mon, 26 Mar 2012 20:23:30 -0400
Subject: [PATCH] adding documentation of -1 return value from
 protected_node_is_locked()

---
 protected_node.module |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/protected_node.module b/protected_node.module
index 535538d..475e762 100644
--- a/protected_node.module
+++ b/protected_node.module
@@ -222,6 +222,9 @@ function protected_node_init() {
  *         Return TRUE if it is protected and cannot be viewed by
  *         the current user. Return $nid if the user has a chance
  *         to unlock this protected node by entering the password.
+ *         Return -1 if the user is trying to view the node and has
+ *         both access to view nodes of that type and the 'view protected
+ *         content' permission.
  */
 function protected_node_is_locked($nid, $op = 'access') {
   global $user;
-- 
1.7.4.4

