diff options
| author | Martin Braun <martin.braun@ettus.com> | 2014-10-14 14:51:09 +0200 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2014-10-14 14:51:09 +0200 |
| commit | 2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6 (patch) | |
| tree | 95c2459895cf42450972df61a069f08bd0fd67d0 /host/docs/uhd.dox | |
| parent | e82f7f0e7e49ec9b25dd65249fb603aeca6f283e (diff) | |
| download | uhd-2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6.tar.gz uhd-2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6.tar.bz2 uhd-2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6.zip | |
docs: Cleaned up and rearranged manual structure
- Removed stray .rst files
- Cleared up TOC, manual is now split into two parts
Diffstat (limited to 'host/docs/uhd.dox')
| -rw-r--r-- | host/docs/uhd.dox | 16 |
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: |