From 0cf870371e068aa5320f082a5f5a7a58eddcb6f2 Mon Sep 17 00:00:00 2001
From: Fabiano Sant'Ana <fabiano@chuva-inc.com>
Date: Sun, 19 May 2013 11:39:13 -0300
Subject: [PATCH] Issue #1998360 by wundo: Updating og_user_access
 documentation

---
 og.module |   15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/og.module b/og.module
index f19f914..8e5cf2d 100644
--- a/og.module
+++ b/og.module
@@ -2026,18 +2026,19 @@ function og_ungroup($group_type, $gid, $entity_type = 'user', $etid = NULL) {
  * @param $account
  *   (optional) The account to check. Defaults to the current user.
  * @param $skip_alter
- *   If TRUE then user access will not be sent to other modules using
- *   drupal_alter(). This can be used by modules implementing
+ *   (optional) If TRUE then user access will not be sent to other modules
+ *   using drupal_alter(). This can be used by modules implementing
  *   hook_og_user_access_alter() that still want to use og_user_access(), but
  *   without causing a recursion. Defaults to FALSE.
  * @param $ignore_admin
- *   When TRUE the specific permission is checked, ignoring the "administer
- *   group" permission if the user has it. When FALSE, a user with "administer
- *   group" will be granted all permissions. Defaults to FALSE.
+ *   (optional) When TRUE the specific permission is checked, ignoring the
+ *   "administer group" permission if the user has it. When FALSE, a user
+ *   with "administer group" will be granted all permissions.
+ *   Defaults to FALSE.
  *
  * @return
- *   TRUE or FALSE if the current user has the requested permission. NULL, if
- *   the given group isn't a valid group.
+ *   TRUE or FALSE if the current user has the requested permission.
+ *   NULL, if the given group isn't a valid group.
  */
 function og_user_access($group_type, $gid, $string, $account = NULL, $skip_alter = FALSE, $ignore_admin = FALSE) {
   global $user;
-- 
1.7.9.6 (Apple Git-31.1)

