From c0638dae6cbf8915e6a436d575562fc131ba772a Mon Sep 17 00:00:00 2001 From: Matthieu Patou Date: Sat, 13 Oct 2012 15:28:08 -0700 Subject: libcli-security: Add documentation for object_tree_modify_access Reviewed-by: Andrew Bartlett --- libcli/security/object_tree.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'libcli') diff --git a/libcli/security/object_tree.c b/libcli/security/object_tree.c index 3e5ee10951..fd00068ef7 100644 --- a/libcli/security/object_tree.c +++ b/libcli/security/object_tree.c @@ -104,8 +104,18 @@ struct object_tree *get_object_tree_by_GUID(struct object_tree *root, return result; } -/* Change the granted access per each ACE */ - +/** + * @brief Modify the tree to mark specified access rights as granted + * + * This function will modify the root and the child of the tree pointed by + * root, so that for each tree element the bits set in access_mask are + * marked as granted. + * + * @param[in] root An object_tree structure that we want to modify + * + * @param[in] access_mask A bitfield of access right that we want to mark as + * granted in the whole tree. + */ void object_tree_modify_access(struct object_tree *root, uint32_t access_mask) { -- cgit