diff options
author | Klaus Weidenbach <Klaus.Weidenbach@gmx.net> | 2017-12-23 14:42:23 +0100 |
---|---|---|
committer | Klaus Weidenbach <Klaus.Weidenbach@gmx.net> | 2018-01-05 01:38:20 +0100 |
commit | aa63c23839990045e8e4a1a283b91a1cd21e1e9c (patch) | |
tree | 6b67b47ff865e407fcf5c0cc240cb0ae1f2c1260 /Zotlabs/Access/AccessList.php | |
parent | 0bb5f38ba50dbeca5217a637cdc4b6abbe725b35 (diff) | |
download | volse-hubzilla-aa63c23839990045e8e4a1a283b91a1cd21e1e9c.tar.gz volse-hubzilla-aa63c23839990045e8e4a1a283b91a1cd21e1e9c.tar.bz2 volse-hubzilla-aa63c23839990045e8e4a1a283b91a1cd21e1e9c.zip |
:bulb: Add source documentation from recent conversations.
There have been some conversations in the last weeks which explained
several parts of the code, so add it to the source code documentation.
Also some other small source code documentation improvements.
Diffstat (limited to 'Zotlabs/Access/AccessList.php')
-rw-r--r-- | Zotlabs/Access/AccessList.php | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Zotlabs/Access/AccessList.php b/Zotlabs/Access/AccessList.php index 6471b0b1d..7cf7b5587 100644 --- a/Zotlabs/Access/AccessList.php +++ b/Zotlabs/Access/AccessList.php @@ -3,10 +3,14 @@ namespace Zotlabs\Access; /** - * @brief AccessList class. + * @brief AccessList class which represents individual content ACLs. * * A class to hold an AccessList object with allowed and denied contacts and * groups. + * + * After evaluating @ref ::Zotlabs::Access::PermissionLimits "PermissionLimits" + * and @ref ::Zotlabs::Lib::Permcat "Permcat"s individual content ACLs are evaluated. + * These answer the question "Can Joe view *this* album/photo?". */ class AccessList { /** @@ -103,7 +107,7 @@ class AccessList { * @brief Return an array consisting of the current access list components * where the elements are directly storable. * - * @return Associative array with: + * @return array An associative array with: * * \e string \b allow_cid => string of allowed cids * * \e string \b allow_gid => string of allowed gids * * \e string \b deny_cid => string of denied cids |