aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/uhd.dox
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs/uhd.dox')
-rw-r--r--host/docs/uhd.dox16
1 files changed, 16 insertions, 0 deletions
diff --git a/host/docs/uhd.dox b/host/docs/uhd.dox
new file mode 100644
index 000000000..5b0738969
--- /dev/null
+++ b/host/docs/uhd.dox
@@ -0,0 +1,16 @@
+/*! \page page_uhd UHD Development Manual
+
+# API Documentation
+
+The majority of the actual API documentation is in the auto-generated part of the manual.
+Use the tree browser at the left to click your way through the class list, the namespaces or files.
+Also, the search bar at the top can be used to search for function calls, classes or any other
+publically available symbol in the UHD namespace.
+
+Some additional pages on developing UHD are also available here:
+
+\li \subpage page_coding
+\li \subpage page_stream
+
+*/
+// vim:ft=doxygen: