Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc: be accurate about allocated returns #841

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions base/nvti.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 *
Expand Down Expand Up @@ -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 *
Expand Down Expand Up @@ -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 *
Expand Down Expand Up @@ -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.
*/
Expand Down