fixes UCX_FOREACH documentation

Tue, 23 Aug 2016 12:41:04 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 23 Aug 2016 12:41:04 +0200
changeset 220
1f57f196d221
parent 219
2df780a4482b
child 221
ebfc6a2902f7

fixes UCX_FOREACH documentation

ucx/list.h file | annotate | diff | comparison | revisions
     1.1 --- a/ucx/list.h	Fri Mar 11 18:06:27 2016 +0100
     1.2 +++ b/ucx/list.h	Tue Aug 23 12:41:04 2016 +0200
     1.3 @@ -46,13 +46,13 @@
     1.4  /**
     1.5   * Loop statement for UCX lists.
     1.6   * 
     1.7 - * The first argument is a pointer to the list. In most cases this will be the
     1.8 + * The first argument is the name of the iteration variable. The scope of
     1.9 + * this variable is limited to the <code>UCX_FOREACH</code> statement.
    1.10 + * 
    1.11 + * The second argument is a pointer to the list. In most cases this will be the
    1.12   * pointer to the first element of the list, but it may also be an arbitrary
    1.13   * element of the list. The iteration will then start with that element.
    1.14   * 
    1.15 - * The second argument is the name of the iteration variable. The scope of
    1.16 - * this variable is limited to the <code>UCX_FOREACH</code> statement.
    1.17 - * 
    1.18   * @param list The first element of the list
    1.19   * @param elem The variable name of the element
    1.20   */

mercurial