1.1 --- a/ucx/list.h Thu Sep 08 12:04:01 2016 +0200
1.2 +++ b/ucx/list.h Thu Sep 08 15:12:56 2016 +0200
1.3 @@ -1,7 +1,7 @@
1.4 /*
1.5 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 *
1.7 - * Copyright 2015 Olaf Wintermann. All rights reserved.
1.8 + * Copyright 2016 Olaf Wintermann. All rights reserved.
1.9 *
1.10 * Redistribution and use in source and binary forms, with or without
1.11 * modification, are permitted provided that the following conditions are met:
1.12 @@ -102,13 +102,12 @@
1.13 UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data);
1.14
1.15 /**
1.16 - * Creates an element-wise copy of a list using an UcxAllocator.
1.17 + * Creates an element-wise copy of a list using a UcxAllocator.
1.18 *
1.19 * See ucx_list_clone() for details.
1.20 *
1.21 - * Keep in mind, that you might want to pass the allocator as an (part of the)
1.22 - * argument for the <code>data</code> parameter, if you want the copy_func() to
1.23 - * make use of the allocator.
1.24 + * You might want to pass the allocator via the <code>data</code> parameter,
1.25 + * to access it within the copy function for making deep copies.
1.26 *
1.27 * @param allocator the allocator to use
1.28 * @param list the list to copy
1.29 @@ -158,7 +157,7 @@
1.30 void ucx_list_free(UcxList *list);
1.31
1.32 /**
1.33 - * Destroys the entire list using an UcxAllocator.
1.34 + * Destroys the entire list using a UcxAllocator.
1.35 *
1.36 * See ucx_list_free() for details.
1.37 *
1.38 @@ -197,7 +196,7 @@
1.39 UcxList *ucx_list_append(UcxList *list, void *data);
1.40
1.41 /**
1.42 - * Inserts an element at the end of the list using an UcxAllocator.
1.43 + * Inserts an element at the end of the list using a UcxAllocator.
1.44 *
1.45 * See ucx_list_append() for details.
1.46 *
1.47 @@ -228,7 +227,7 @@
1.48 UcxList *ucx_list_prepend(UcxList *list, void *data);
1.49
1.50 /**
1.51 - * Inserts an element at the beginning of the list using an UcxAllocator.
1.52 + * Inserts an element at the beginning of the list using a UcxAllocator.
1.53 *
1.54 * See ucx_list_prepend() for details.
1.55 *
1.56 @@ -343,7 +342,7 @@
1.57 int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
1.58
1.59 /**
1.60 - * Sorts an UcxList with natural merge sort.
1.61 + * Sorts a UcxList with natural merge sort.
1.62 *
1.63 * This function uses O(n) additional temporary memory for merge operations
1.64 * that is automatically freed after each merge.
1.65 @@ -373,7 +372,7 @@
1.66 UcxList *ucx_list_remove(UcxList *list, UcxList *element);
1.67
1.68 /**
1.69 - * Removes an element from the list using an UcxAllocator.
1.70 + * Removes an element from the list using a UcxAllocator.
1.71 *
1.72 * See ucx_list_remove() for details.
1.73 *
