Doc: libcrmcommon: document pcmk_acl_required()

Ken Gaillot · Ken Gaillot · commit 0d74141d7d10 · 2020-03-17T13:46:39.000-05:00
diff --git a/lib/common/acl.c b/lib/common/acl.c
@@ -697,6 +697,13 @@ pcmk__check_acl(xmlNode *xml, const char *name, enum xml_private_flags mode)
     return TRUE;
 }
 
+/*!
+ * \brief Check whether ACLs are required for a given user
+ *
+ * \param[in]  User name to check
+ *
+ * \return true if the user requires ACLs, false otherwise
+ */
 bool
 pcmk_acl_required(const char *user)
 {

Original file line number	Diff line number	Diff line change
`@@ -697,6 +697,13 @@ pcmk__check_acl(xmlNode xml, const char name, enum xml_private_flags mode)`
`697`	`697`	`return TRUE;`
`698`	`698`	`}`
`699`	`699`
	`700`	`+/*!`
	`701`	`+ * \brief Check whether ACLs are required for a given user`
	`702`	`+ *`
	`703`	`+ * \param[in] User name to check`
	`704`	`+ *`
	`705`	`+ * \return true if the user requires ACLs, false otherwise`
	`706`	`+ */`
`700`	`707`	`bool`
`701`	`708`	`pcmk_acl_required(const char *user)`
`702`	`709`	`{`