docs/Writerside/topics/features.md@9b6c3474af43 (annotated)
docs/Writerside/topics/features.md
Wed, 12 Feb 2025 19:40:59 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Wed, 12 Feb 2025 19:40:59 +0100
- changeset 1205
- 9b6c3474af43
- parent 1141
- a06a2d27c043
- permissions
- -rw-r--r--
add introduction text for API documentation
|
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 | |
|
9b6c3474af43
add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents:
1141
diff
changeset
|
9 | If you want more detailed documentation and examples, refer to one of the Sections listed in the left menu. |
|
9b6c3474af43
add introduction text for API documentation
Mike Becker <universe@uap-core.de>
parents:
1141
diff
changeset
|
10 |
