From e5d4007dcbe51481836475dd4e527a3a6fc963bf Mon Sep 17 00:00:00 2001 From: okunj4 <36168902+okunj4@users.noreply.github.com> Date: Tue, 26 Mar 2019 08:13:52 -0400 Subject: [PATCH 1/3] Update list.h Updated List_Remove and List_UnlinkItem --- include/list.h | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/include/list.h b/include/list.h index b8dad0d0..671f84e6 100644 --- a/include/list.h +++ b/include/list.h @@ -252,32 +252,36 @@ void List_RemoveFirst(list_t* list); void List_RemoveLast(list_t* list); /** + * Removes an element of list + * @param list a pointer to a list_t + * @param identifier for the item to remove in the list. + * @return a void pointer to the item found using the identifier. Returns 0 if not found. * - * @param list - * @param item - * + * @warning This method does not return the items that were removed. */ void List_Remove(list_t* list, void* item); /** * Removes all elements of list. * @param list a pointer to a list_t - * + * * @warning This method does not return the items that were removed. * */ void List_RemoveAll(list_t* list); /** + * Unlinks an item of list. If a valid pointer is not found an error code may be given + * @param lists a pointer to a list_t + * @param identifier for the item to unlink in the list. + * @return a void pointer to the item found using the identifier. Returns 0 if not found. * - * @param list - * @param item - * + * @warning This method does not return the items that were unlinked. */ void List_UnlinkItem(list_t* list, void* item); /** - * + * * @param list pointer to list structure (object) * *Function: List_UnlinkFirst(list_t* list) From 6b67ab6bcba106063dad0dda11c56c1597060a65 Mon Sep 17 00:00:00 2001 From: okunj4 <36168902+okunj4@users.noreply.github.com> Date: Tue, 26 Mar 2019 10:51:09 -0400 Subject: [PATCH 2/3] Update list.h Fixed change as requested. --- include/list.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/list.h b/include/list.h index 671f84e6..8c3e16a4 100644 --- a/include/list.h +++ b/include/list.h @@ -255,7 +255,7 @@ void List_RemoveLast(list_t* list); * Removes an element of list * @param list a pointer to a list_t * @param identifier for the item to remove in the list. - * @return a void pointer to the item found using the identifier. Returns 0 if not found. + * @return a void pointer to the item found using the identifier, therefore pointing the item to be removed. * * @warning This method does not return the items that were removed. */ @@ -274,7 +274,7 @@ void List_RemoveAll(list_t* list); * Unlinks an item of list. If a valid pointer is not found an error code may be given * @param lists a pointer to a list_t * @param identifier for the item to unlink in the list. - * @return a void pointer to the item found using the identifier. Returns 0 if not found. + * @return a void pointer to the item found using the identifier, therefore pointing the item to be unlinked. * * @warning This method does not return the items that were unlinked. */ From 6f2822dd806290abe366c1ed904209fa2328ae06 Mon Sep 17 00:00:00 2001 From: okunj4 <36168902+okunj4@users.noreply.github.com> Date: Tue, 26 Mar 2019 17:46:36 -0400 Subject: [PATCH 3/3] Update list.h Updated the statements to reflect what you said. --- include/list.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/list.h b/include/list.h index 8c3e16a4..a60c771a 100644 --- a/include/list.h +++ b/include/list.h @@ -255,7 +255,7 @@ void List_RemoveLast(list_t* list); * Removes an element of list * @param list a pointer to a list_t * @param identifier for the item to remove in the list. - * @return a void pointer to the item found using the identifier, therefore pointing the item to be removed. + * @return is a pointer that removes the item and returns no value. * * @warning This method does not return the items that were removed. */ @@ -274,7 +274,7 @@ void List_RemoveAll(list_t* list); * Unlinks an item of list. If a valid pointer is not found an error code may be given * @param lists a pointer to a list_t * @param identifier for the item to unlink in the list. - * @return a void pointer to the item found using the identifier, therefore pointing the item to be unlinked. + * @return is a pointer that unlinks the item and returns no value. * * @warning This method does not return the items that were unlinked. */