From: James Jones <jejones3141@gmail.com>
Date: Fri, 29 Apr 2022 12:32:12 +0000 (-0500)
Subject: Correction to description of function return values (#4472)
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cc5a1049c5bc3631723f8dc8bd6b63f5cb130ec5;p=thirdparty%2Ffreeradius-server.git

Correction to description of function return values (#4472)
---

diff --git a/src/lib/util/dict_unknown.c b/src/lib/util/dict_unknown.c
index 74f36e00cc0..b16a80fa576 100644
--- a/src/lib/util/dict_unknown.c
+++ b/src/lib/util/dict_unknown.c
@@ -263,8 +263,8 @@ fr_dict_attr_t *fr_dict_unknown_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *
  * @param[in] parent		of the VSA attribute.
  * @param[in] vendor		id.
  * @return
- *	- 0 on success.
- *	- -1 on failure.
+ *	- An fr_dict_attr_t on success.
+ *	- NULL on failure.
  */
 fr_dict_attr_t	*fr_dict_unknown_vendor_afrom_num(TALLOC_CTX *ctx,
 						  fr_dict_attr_t const *parent, unsigned int vendor)
@@ -302,8 +302,8 @@ fr_dict_attr_t	*fr_dict_unknown_vendor_afrom_num(TALLOC_CTX *ctx,
  * @param[in] parent		of the unknown attribute (may also be unknown).
  * @param[in] num		of the unknown attribute.
  * @return
- *	- 0 on success.
- *	- -1 on failure.
+ *	- An fr_dict_attr_t on success.
+ *	- NULL on failure.
  */
 fr_dict_attr_t *fr_dict_unknown_tlv_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int num)
 {
@@ -329,8 +329,8 @@ fr_dict_attr_t *fr_dict_unknown_tlv_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t co
  * @param[in] parent		of the unknown attribute (may also be unknown).
  * @param[in] num		of the unknown attribute.
  * @return
- *	- 0 on success.
- *	- -1 on failure.
+ *	- An fr_dict_attr_t on success.
+ *	- NULL on failure.
  */
 fr_dict_attr_t	*fr_dict_unknown_attr_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int num)
 {
diff --git a/src/lib/util/dict_util.c b/src/lib/util/dict_util.c
index 7f98222e368..5bb9234ed9a 100644
--- a/src/lib/util/dict_util.c
+++ b/src/lib/util/dict_util.c
@@ -624,8 +624,8 @@ static int _dict_attr_free(fr_dict_attr_t *da)
  *
  * @param[in] ctx		to allocate attribute in.
  * @return
- *	- 0 on success.
- *	- -1 on failure (memory allocation error).
+ *	- A new, partially completed, fr_dict_attr_t on success.
+ *	- NULL on failure (memory allocation error).
  */
 fr_dict_attr_t *dict_attr_alloc_null(TALLOC_CTX *ctx)
 {