adds deprecation notice for *_append/prepend_once()

Fri, 11 May 2018 18:35:08 +0200

author
Mike Becker <universe@uap-core.de>
date
Fri, 11 May 2018 18:35:08 +0200
changeset 293
d994325445f1
parent 292
d9abf53b8397
child 294
bfa935ab7f85

adds deprecation notice for *_append/prepend_once()

src/ucx/list.h file | annotate | diff | comparison | revisions
     1.1 --- a/src/ucx/list.h	Fri May 11 18:13:54 2018 +0200
     1.2 +++ b/src/ucx/list.h	Fri May 11 18:35:08 2018 +0200
     1.3 @@ -215,6 +215,12 @@
     1.4  /**
     1.5   * Inserts an element at the end of the list, if it is not present in the list.
     1.6   * 
     1.7 + * <b>Note:</b> You should not try to store a freshly allocated object. Since
     1.8 + * it might be a duplicate, the memory allocated for that copy would be leaking
     1.9 + * afterwards.
    1.10 + * 
    1.11 + * <b>Deprecation notice:</b> This function is considered to do more harm than
    1.12 + * it adds usefulness and is going to be removed in a future UCX release.
    1.13   * 
    1.14   * @param list the list where to append the data, or <code>NULL</code> to
    1.15   * create a new list
    1.16 @@ -232,6 +238,13 @@
    1.17   * Inserts an element at the end of the list, if it is not present in the list,
    1.18   * using a UcxAllocator.
    1.19   * 
    1.20 + * <b>Note:</b> You should not try to store a freshly allocated object. Since
    1.21 + * it might be a duplicate, the memory allocated for that copy would be leaking
    1.22 + * afterwards.
    1.23 + * 
    1.24 + * <b>Deprecation notice:</b> This function is considered to do more harm than
    1.25 + * it adds usefulness and is going to be removed in a future UCX release.
    1.26 + * 
    1.27   * @param allocator the allocator to use
    1.28   * @param list the list where to append the data, or <code>NULL</code> to
    1.29   * create a new list
    1.30 @@ -249,6 +262,12 @@
    1.31   * Inserts an element at the beginning of the list, if it is not present
    1.32   * in the list.
    1.33   * 
    1.34 + * <b>Note:</b> You should not try to store a freshly allocated object. Since
    1.35 + * it might be a duplicate, the memory allocated for that copy would be leaking
    1.36 + * afterwards.
    1.37 + * 
    1.38 + * <b>Deprecation notice:</b> This function is considered to do more harm than
    1.39 + * it adds usefulness and is going to be removed in a future UCX release.
    1.40   * 
    1.41   * @param list the list where to prepend the data, or <code>NULL</code> to
    1.42   * create a new list
    1.43 @@ -265,6 +284,13 @@
    1.44   * Inserts an element at the beginning of the list, if it is not present in
    1.45   * the list, using a UcxAllocator.
    1.46   * 
    1.47 + * <b>Note:</b> You should not try to store a freshly allocated object. Since
    1.48 + * it might be a duplicate, the memory allocated for that copy would be leaking
    1.49 + * afterwards.
    1.50 + * 
    1.51 + * <b>Deprecation notice:</b> This function is considered to do more harm than
    1.52 + * it adds usefulness and is going to be removed in a future UCX release.
    1.53 + * 
    1.54   * @param allocator the allocator to use
    1.55   * @param list the list where to prepend the data, or <code>NULL</code> to
    1.56   * create a new list

mercurial