summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2009-08-01 20:48:59 +0000
committerDries Buytaert <dries@buytaert.net>2009-08-01 20:48:59 +0000
commit1a2d10ecf2f569164dabff10eed3c2ba5306965f (patch)
tree1bd8c209af6be6f4df865453a7a5d2a45bbee89a /modules
parentb3b7be43c0d9025346a5be2ffa4a995629463e96 (diff)
downloadbrdo-1a2d10ecf2f569164dabff10eed3c2ba5306965f.tar.gz
brdo-1a2d10ecf2f569164dabff10eed3c2ba5306965f.tar.bz2
- Patch #310168 by jhodgdon, arianek, traxer: documentation update.
Diffstat (limited to 'modules')
-rw-r--r--modules/system/system.api.php17
1 files changed, 9 insertions, 8 deletions
diff --git a/modules/system/system.api.php b/modules/system/system.api.php
index eef1e2fce..9c5435275 100644
--- a/modules/system/system.api.php
+++ b/modules/system/system.api.php
@@ -650,17 +650,18 @@ function hook_system_info_alter(&$info, $file) {
* can be selected on the user permissions page and used to grant or restrict
* access to actions the module performs.
*
- * @return
- * An array of permissions where the permission name is the array key and the
- * corresponding key value is an array of key/value pairs specifying
- * the permission's title and description
- *
- * The permissions in the array do not need to be wrapped with the function t(),
- * since the string extractor takes care of extracting permission names defined in the perm hook for translation.
- *
* Permissions are checked using user_access().
*
* For a detailed usage example, see page_example.module.
+ *
+ * @return
+ * An array of which permission names are the keys and their corresponding
+ * values are descriptions of each permission.
+ * The permission names (keys of the array) must not be wrapped with
+ * the t() function, since the string extractor takes care of
+ * extracting permission names defined in the perm hook for
+ * translation. The permission descriptions (values of the array)
+ * should be wrapped in the t() function so they can be translated.
*/
function hook_permission() {
return array(