Wed, 12 Feb 2025 19:40:59 +0100
add introduction text for API documentation
docs/Writerside/topics/features.md | file | annotate | diff | comparison | revisions |
--- a/docs/Writerside/topics/features.md Tue Feb 11 21:58:33 2025 +0100 +++ b/docs/Writerside/topics/features.md Wed Feb 12 19:40:59 2025 +0100 @@ -1,1 +1,10 @@ # API Documentation + +Documentation of the UCX API is available as [Doxygen API Docs](https://ucx.sourceforge.io/api/), +generated from code, as well as handwritten documentation right here on this website. + +The Doxygen docstrings are written so that many IDEs can read them directly from the header files +and generate useful quick help while you are typing your code. + +If you want more detailed documentation and examples, refer to one of the Sections listed in the left menu. +