comparison: docs/src/modules.md
docs/src/modules.md
- changeset 282
- 39e69d78b01d
- parent 281
- e8146a561e73
- child 287
- 98da78a1e69a
equal
deleted
inserted
replaced
| 281:e8146a561e73 | 282:39e69d78b01d |
|---|---|
| 7 file. | 7 file. |
| 8 Please note, that some modules make use of other UCX modules. | 8 Please note, that some modules make use of other UCX modules. |
| 9 For instance, the [Allocator](#allocator) module is used by many other modules | 9 For instance, the [Allocator](#allocator) module is used by many other modules |
| 10 to allow flexible memory allocation. | 10 to allow flexible memory allocation. |
| 11 By default the header files are placed into an `ucx` directory within your | 11 By default the header files are placed into an `ucx` directory within your |
| 12 systems include directory. In this case you can use an module by including it | 12 systems include directory. In this case you can use a module by including it |
| 13 via `#include <ucx/MODULENAME.h>`. | 13 via `#include <ucx/MODULENAME.h>`. |
| 14 Required modules are included automatically. | 14 Required modules are included automatically. |
| 15 | 15 |
| 16 <div id="modules" align="center"> | 16 <div id="modules" align="center"> |
| 17 | 17 |
| 56 *Header file:* [buffer.h](api/buffer_8h.html) | 56 *Header file:* [buffer.h](api/buffer_8h.html) |
| 57 *Required modules:* None. | 57 *Required modules:* None. |
| 58 | 58 |
| 59 Instances of this buffer implementation can be used to read from or to write to | 59 Instances of this buffer implementation can be used to read from or to write to |
| 60 memory like you would do with a stream. This allows the use of | 60 memory like you would do with a stream. This allows the use of |
| 61 `ucx_stream_copy` from the [Utilities](#utilities) module to copy contents from one | 61 `ucx_stream_copy()` from the [Utilities](#utilities) module to copy contents |
| 62 buffer to another or from file or network streams to the buffer and | 62 from one buffer to another or from file or network streams to the buffer and |
| 63 vice-versa. | 63 vice-versa. |
| 64 | 64 |
| 65 More features for convenient use of the buffer can be enabled, like automatic | 65 More features for convenient use of the buffer can be enabled, like automatic |
| 66 memory management and automatic resizing of the buffer space. | 66 memory management and automatic resizing of the buffer space. |
| 67 See the documentation of the macro constants in the header file for more | 67 See the documentation of the macro constants in the header file for more |
