docs/Writerside/topics/features.md

Tue, 09 Sep 2025 22:30:18 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 09 Sep 2025 22:30:18 +0200
changeset 1367
6b3d52dd176e
parent 1251
b4b248a8b2d6
permissions
-rw-r--r--

change linked_list.c to allow custom data in nodes + implement cx_kv_list_set_key()

relates to #461

1141
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents: 1140
diff changeset
1 # API Documentation
1205
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
2
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
3 Documentation of the UCX API is available as [Doxygen API Docs](https://ucx.sourceforge.io/api/),
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
4 generated from code, as well as handwritten documentation right here on this website.
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
5
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
6 The Doxygen docstrings are written so that many IDEs can read them directly from the header files
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
7 and generate useful quick help while you are typing your code.
9b6c3474af43 add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
8
1251
b4b248a8b2d6 remove the lie about the detailed documentation
Mike Becker <universe@uap-core.de>
parents: 1205
diff changeset
9 If you are looking for an overview and examples, refer to one of the Sections listed in the left menu.

mercurial