The documentation was added as a kind of test for sphinx + autodoc.
As such, several variants were used, for example doc entries without
parameter description.
Now that sphinx + autodoc are merged, add the full doc for all functions.
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx>
---
ptrlist.c | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/ptrlist.c b/ptrlist.c
index 99771e437..c7ebf5a3f 100644
--- a/ptrlist.c
+++ b/ptrlist.c
@@ -278,7 +278,11 @@ out:
}
///
-// remove the last entry but doesn't pack the ptr list
+// remove the last entry of a ptrlist
+// @head: a pointer to the list
+// @return: the last elemant of the list or NULL if the list is empty.
+//
+// :note: this doesn't repack the list
void * undo_ptr_list_last(struct ptr_list **head)
{
struct ptr_list *last, *first = *head;
@@ -301,6 +305,8 @@ void * undo_ptr_list_last(struct ptr_list **head)
///
// remove the last entry and repack the list
+// @head: a pointer to the list
+// @return: the last elemant of the list or NULL if the list is empty.
void * delete_ptr_list_last(struct ptr_list **head)
{
void *ptr = NULL;
--
2.17.1
--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
