comparison: ucx/ucx.h
ucx/ucx.h
- changeset 115
- 965fd17ed9cf
- parent 114
- 5a0859739b76
- child 116
- 234920008754
equal
deleted
inserted
replaced
| 114:5a0859739b76 | 115:965fd17ed9cf |
|---|---|
| 27 */ | 27 */ |
| 28 /** | 28 /** |
| 29 * Main UCX Header providing most common definitions. | 29 * Main UCX Header providing most common definitions. |
| 30 * | 30 * |
| 31 * @file ucx.h | 31 * @file ucx.h |
| 32 * @author Mike Becker | |
| 32 * @author Olaf Wintermann | 33 * @author Olaf Wintermann |
| 33 */ | 34 */ |
| 34 | 35 |
| 35 #ifndef UCX_H | 36 #ifndef UCX_H |
| 36 #define UCX_H | 37 #define UCX_H |
| 48 /** | 49 /** |
| 49 * Generic loop statement for lists. | 50 * Generic loop statement for lists. |
| 50 * | 51 * |
| 51 * The first argument is the type of the list and its elements (e.g. UcxList). | 52 * The first argument is the type of the list and its elements (e.g. UcxList). |
| 52 * The structure invariant of the list must be as follows: | 53 * The structure invariant of the list must be as follows: |
| 54 * | |
| 53 * <ul> | 55 * <ul> |
| 54 * <li>a first (non-<code>NULL</code>) element</li> | 56 * <li>a first (non-<code>NULL</code>) element</li> |
| 55 * <li>for each element a reference to the <code>next</code> element (the | 57 * <li>for each element a reference to the <code>next</code> element (the |
| 56 * variable name of the pointer MUST be <code>next</code>)</li> | 58 * variable name of the pointer MUST be <code>next</code>)</li> |
| 57 * <li>the last element of the list MUST have the <code>next</code> pointer | 59 * <li>the last element of the list MUST have the <code>next</code> pointer |
