From 8d8d6c41cdd948d5c36ce3cce37603e8252042c0 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Wed, 16 Oct 2024 12:55:59 +0200 Subject: [PATCH] Fix doc: be accurate about allocated returns --- base/nvti.c | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/base/nvti.c b/base/nvti.c index 5a9df616..3032509a 100644 --- a/base/nvti.c +++ b/base/nvti.c @@ -70,8 +70,7 @@ typedef struct vtref * * @param ref_text The optional text accompanying a reference. * - * @return NULL in case the memory could not be allocated. - * Else a vtref structure which needs to be + * @return A vtref structure which needs to be * released using @ref vtref_free . */ vtref_t * @@ -174,8 +173,7 @@ typedef struct vtseverity * @param[in] score The score to be set. * @param[in] value The value corresponding to the type. * - * @return NULL in case the memory could not be allocated. - * Else a vtref structure which needs to be + * @return A vtref structure which needs to be * released using @ref vtref_free . */ vtseverity_t * @@ -458,8 +456,7 @@ typedef struct nvtpref * * @param dflt The default to be set. A copy will created of this. * - * @return NULL in case the memory could not be allocated. - * Else a nvtpref structure which needs to be + * @return An nvtpref structure which needs to be * released using @ref nvtpref_free . */ nvtpref_t * @@ -554,8 +551,7 @@ nvtpref_default (const nvtpref_t *np) /** * @brief Create a new (empty) nvti structure. * - * @return NULL in case the memory could not be allocated. - * Else an empty nvti structure which needs to be + * @return An empty nvti structure which needs to be * released using @ref nvti_free . * The whole struct is initialized with 0's. */