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 74f36e00cc096744c99f51fa2d71dcd6f784ef03..b16a80fa576f7fc712d73bede2b4f7d5dd7986b3 100644 (file)
--- 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 7f98222e368ea3200992789504fb7a98013aae3b..5bb9234ed9a8467b10cad4ab71e29dc8a257e339 100644 (file)
--- 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)
 {