Thu, 08 Sep 2016 15:12:56 +0200
updates documenting comments
--- a/LICENSE Thu Sep 08 12:04:01 2016 +0200 +++ b/LICENSE Thu Sep 08 15:12:56 2016 +0200 @@ -1,4 +1,4 @@ -Copyright 2015 Olaf Wintermann. All rights reserved. +Copyright 2016 Olaf Wintermann. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
--- a/Makefile Thu Sep 08 12:04:01 2016 +0200 +++ b/Makefile Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/README Thu Sep 08 12:04:01 2016 +0200 +++ b/README Thu Sep 08 15:12:56 2016 +0200 @@ -87,7 +87,7 @@ 6. License ---------- -Copyright 2015 Olaf Wintermann. All rights reserved. +Copyright 2016 Olaf Wintermann. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
--- a/clang.mk Thu Sep 08 12:04:01 2016 +0200 +++ b/clang.mk Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/g++.mk Thu Sep 08 12:04:01 2016 +0200 +++ b/g++.mk Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/gcc.mk Thu Sep 08 12:04:01 2016 +0200 +++ b/gcc.mk Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/mingw.mk Thu Sep 08 12:04:01 2016 +0200 +++ b/mingw.mk Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/osx.mk Thu Sep 08 12:04:01 2016 +0200 +++ b/osx.mk Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/suncc.mk Thu Sep 08 12:04:01 2016 +0200 +++ b/suncc.mk Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/test/Makefile Thu Sep 08 12:04:01 2016 +0200 +++ b/test/Makefile Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/test/allocator_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/allocator_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/allocator_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/allocator_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/avl_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/avl_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/avl_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/avl_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/buffer_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/buffer_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/buffer_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/buffer_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/list_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/list_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/list_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/list_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/logging_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/logging_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/logging_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/logging_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/main.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/main.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/main.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/main.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/map_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/map_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/map_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/map_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/mpool_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/mpool_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/mpool_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/mpool_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/prop_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/prop_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/prop_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/prop_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/stack_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/stack_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/stack_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/stack_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/string_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/string_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/string_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/string_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/utils_tests.c Thu Sep 08 12:04:01 2016 +0200 +++ b/test/utils_tests.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/test/utils_tests.h Thu Sep 08 12:04:01 2016 +0200 +++ b/test/utils_tests.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/Makefile Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/Makefile Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. # -# Copyright 2015 Olaf Wintermann. All rights reserved. +# Copyright 2016 Olaf Wintermann. All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met:
--- a/ucx/allocator.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/allocator.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/allocator.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/allocator.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -28,7 +28,7 @@ /** * Allocator for custom memory management. * - * An UCX allocator consists of a pointer to the memory area / pool and four + * A UCX allocator consists of a pointer to the memory area / pool and four * function pointers to memory management functions operating on this memory * area / pool. These functions shall behave equivalent to the standard libc * functions <code>malloc(), calloc(), realloc()</code> and <code>free()</code>. @@ -38,7 +38,7 @@ * memory area / pool as first argument. * * As the pointer to the memory area / pool can be arbitrarily chosen, any data - * can be provided to the memory management functions. An UcxMempool is just + * can be provided to the memory management functions. A UcxMempool is just * one example. * * @see mempool.h @@ -116,7 +116,7 @@ * management functions. Use this function to get a pointer to a globally * available allocator. You may also define an own UcxAllocator by assigning * #UCX_ALLOCATOR_DEFAULT to a variable and pass the address of this variable - * to any function that takes an UcxAllocator as argument. Note that using + * to any function that takes a UcxAllocator as argument. Note that using * this function is the recommended way of passing a default allocator, thus * it never runs out of scope. *
--- a/ucx/avl.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/avl.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/avl.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/avl.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -134,7 +134,7 @@ UcxAVLTree *ucx_avl_new_a(cmp_func cmpfunc, UcxAllocator *allocator); /** - * Destroys an UcxAVLTree. + * Destroys a UcxAVLTree. * @param tree the tree to destroy */ void ucx_avl_free(UcxAVLTree *tree);
--- a/ucx/buffer.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/buffer.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/buffer.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/buffer.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -197,7 +197,7 @@ int ucx_buffer_extend(UcxBuffer *buffer, size_t additional_bytes); /** - * Writes data to an UcxBuffer. + * Writes data to a UcxBuffer. * * The position of the buffer is increased by the number of bytes written. * @@ -211,7 +211,7 @@ UcxBuffer *buffer); /** - * Reads data from an UcxBuffer. + * Reads data from a UcxBuffer. * * The position of the buffer is increased by the number of bytes read. *
--- a/ucx/list.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/list.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/list.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/list.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -102,13 +102,12 @@ UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data); /** - * Creates an element-wise copy of a list using an UcxAllocator. + * Creates an element-wise copy of a list using a UcxAllocator. * * See ucx_list_clone() for details. * - * Keep in mind, that you might want to pass the allocator as an (part of the) - * argument for the <code>data</code> parameter, if you want the copy_func() to - * make use of the allocator. + * You might want to pass the allocator via the <code>data</code> parameter, + * to access it within the copy function for making deep copies. * * @param allocator the allocator to use * @param list the list to copy @@ -158,7 +157,7 @@ void ucx_list_free(UcxList *list); /** - * Destroys the entire list using an UcxAllocator. + * Destroys the entire list using a UcxAllocator. * * See ucx_list_free() for details. * @@ -197,7 +196,7 @@ UcxList *ucx_list_append(UcxList *list, void *data); /** - * Inserts an element at the end of the list using an UcxAllocator. + * Inserts an element at the end of the list using a UcxAllocator. * * See ucx_list_append() for details. * @@ -228,7 +227,7 @@ UcxList *ucx_list_prepend(UcxList *list, void *data); /** - * Inserts an element at the beginning of the list using an UcxAllocator. + * Inserts an element at the beginning of the list using a UcxAllocator. * * See ucx_list_prepend() for details. * @@ -343,7 +342,7 @@ int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data); /** - * Sorts an UcxList with natural merge sort. + * Sorts a UcxList with natural merge sort. * * This function uses O(n) additional temporary memory for merge operations * that is automatically freed after each merge. @@ -373,7 +372,7 @@ UcxList *ucx_list_remove(UcxList *list, UcxList *element); /** - * Removes an element from the list using an UcxAllocator. + * Removes an element from the list using a UcxAllocator. * * See ucx_list_remove() for details. *
--- a/ucx/logging.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/logging.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/logging.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/logging.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/map.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/map.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/map.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/map.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -59,7 +59,7 @@ * * @param key the variable name for the key * @param value the variable name for the value - * @param iter an UcxMapIterator + * @param iter a UcxMapIterator * @see ucx_map_iterator() */ #define UCX_MAP_FOREACH(key,value,iter) \ @@ -68,13 +68,13 @@ /** Type for the UCX map. @see UcxMap */ typedef struct UcxMap UcxMap; -/** Type for a key of an UcxMap. @see UcxKey */ +/** Type for a key of a UcxMap. @see UcxKey */ typedef struct UcxKey UcxKey; -/** Type for an element of an UcxMap. @see UcxMapElement */ +/** Type for an element of a UcxMap. @see UcxMapElement */ typedef struct UcxMapElement UcxMapElement; -/** Type for an iterator over an UcxMap. @see UcxMapIterator */ +/** Type for an iterator over a UcxMap. @see UcxMapIterator */ typedef struct UcxMapIterator UcxMapIterator; /** Structure for the UCX map. */ @@ -89,7 +89,7 @@ size_t count; }; -/** Structure for a key of an UcxMap. */ +/** Structure for a key of a UcxMap. */ struct UcxKey { /** The key data. */ void *data; @@ -99,7 +99,7 @@ int hash; }; -/** Structure for an element of an UcxMap. */ +/** Structure for an element of a UcxMap. */ struct UcxMapElement { /** The value data. */ void *data; @@ -111,7 +111,7 @@ UcxKey key; }; -/** Structure for an iterator over an UcxMap. */ +/** Structure for an iterator over a UcxMap. */ struct UcxMapIterator { /** The map to iterate over. */ UcxMap *map; @@ -136,7 +136,7 @@ UcxMap *ucx_map_new(size_t size); /** - * Creates a new hash map with the specified size using an UcxAllocator. + * Creates a new hash map with the specified size using a UcxAllocator. * @param allocator the allocator to use * @param size the size of the hash map * @return a pointer to the new hash map @@ -357,13 +357,13 @@ ucx_map_remove(map, ucx_key((void*)&key, sizeof(key))) /** - * Creates an UcxKey based on the given data. + * Creates a UcxKey based on the given data. * * This function implicitly computes the hash. * * @param data the data for the key * @param len the length of the data - * @return an UcxKey with implicitly computed hash + * @return a UcxKey with implicitly computed hash * @see ucx_hash() */ UcxKey ucx_key(void *data, size_t len); @@ -380,14 +380,14 @@ /** * Creates an iterator for a map. * - * <b>Note:</b> An UcxMapIterator iterates over all elements in all element + * <b>Note:</b> A UcxMapIterator iterates over all elements in all element * lists successively. Therefore the order highly depends on the key hashes and * may vary under different map sizes. So generally you may <b>NOT</b> rely on * the iteration order. * * <b>Note:</b> The iterator is <b>NOT</b> initialized. You need to call * ucx_map_iter_next() at least once before accessing any information. However, - * it is not recommended to access the fields of an UcxMapIterator directly. + * it is not recommended to access the fields of a UcxMapIterator directly. * * @param map the map to create the iterator for * @return an iterator initialized on the first element of the
--- a/ucx/mempool.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/mempool.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/mempool.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/mempool.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -176,7 +176,7 @@ * pool is destroyed. * * The only requirement for the specified memory is, that it <b>MUST</b> be - * pooled memory by an UcxMempool or an element-compatible mempool. The pointer + * pooled memory by a UcxMempool or an element-compatible mempool. The pointer * to the destructor function is saved in a reserved area before the actual * memory. *
--- a/ucx/properties.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/properties.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/properties.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/properties.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -127,7 +127,7 @@ UcxProperties *ucx_properties_new(); /** - * Destroys an UcxProperties object. + * Destroys a UcxProperties object. * @param prop the UcxProperties object to destroy */ void ucx_properties_free(UcxProperties *prop); @@ -170,7 +170,7 @@ int ucx_properties_next(UcxProperties *prop, sstr_t *name, sstr_t *value); /** - * Retrieves all available key/value-pairs and puts them into an UcxMap. + * Retrieves all available key/value-pairs and puts them into a UcxMap. * * This is done by successive calls to ucx_properties_next() until no more * key/value-pairs can be retrieved. @@ -183,7 +183,7 @@ int ucx_properties2map(UcxProperties *prop, UcxMap *map); /** - * Loads a properties file to an UcxMap. + * Loads a properties file to a UcxMap. * * This is a convenience function that reads data from an input * stream until the end of the stream is reached. @@ -198,7 +198,7 @@ int ucx_properties_load(UcxMap *map, FILE *file); /** - * Stores an UcxMap to a file. + * Stores a UcxMap to a file. * * The key/value-pairs are written by using the following format: *
--- a/ucx/stack.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/stack.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/stack.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/stack.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/string.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/string.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/string.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/string.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -137,7 +137,7 @@ sstr_t sstrcat(size_t count, sstr_t s1, sstr_t s2, ...); /** - * Concatenates two or more strings using an UcxAllocator. + * Concatenates two or more strings using a UcxAllocator. * * See sstrcat() for details. * @@ -277,7 +277,7 @@ sstr_t* sstrsplit(sstr_t string, sstr_t delim, ssize_t *count); /** - * Performing sstrsplit() using an UcxAllocator. + * Performing sstrsplit() using a UcxAllocator. * * <i>Read the description of sstrsplit() for details.</i> * @@ -348,7 +348,7 @@ sstr_t sstrdup(sstr_t string); /** - * Creates a duplicate of the specified string using an UcxAllocator. + * Creates a duplicate of the specified string using a UcxAllocator. * * The new sstr_t will contain a copy allocated by the allocators * ucx_allocator_malloc function. So it is implementation depended, whether the @@ -358,7 +358,7 @@ * The sstr_t.ptr of the return value will <i>always</i> be <code>NULL</code>- * terminated. * - * @param allocator a valid instance of an UcxAllocator + * @param allocator a valid instance of a UcxAllocator * @param string the string to duplicate * @return a duplicate of the string * @see sstrdup()
--- a/ucx/test.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/test.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/test.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/test.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -160,7 +160,7 @@ /** * Macro for a #UcxTest function header. * - * Use this macro to declare and/or define an #UcxTest function. + * Use this macro to declare and/or define a #UcxTest function. * * @param name the name of the test function */ @@ -196,7 +196,7 @@ /** * Macro for a test subroutine function header. * - * Use this to declare and/or define an subroutine that can be called by using + * Use this to declare and/or define a subroutine that can be called by using * UCX_TEST_CALL_SUBROUTINE(). * * @param name the name of the subroutine
--- a/ucx/ucx.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/ucx.c Thu Sep 08 15:12:56 2016 +0200 @@ -9,7 +9,7 @@ * * <h2>LICENCE</h2> * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/ucx.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/ucx.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/utils.c Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/utils.c Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met:
--- a/ucx/utils.h Thu Sep 08 12:04:01 2016 +0200 +++ b/ucx/utils.h Thu Sep 08 15:12:56 2016 +0200 @@ -1,7 +1,7 @@ /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * - * Copyright 2015 Olaf Wintermann. All rights reserved. + * Copyright 2016 Olaf Wintermann. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -262,7 +262,7 @@ ucx_asprintf(ucx_default_allocator(), __VA_ARGS__) /** - * A <code>printf()</code> like function which writes the output to an + * A <code>printf()</code> like function which writes the output to a * UcxBuffer. * * @param buffer the buffer the data is written to