summaryrefslogtreecommitdiff
path: root/docs/doxygen/other/components.dox
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2014-07-16 11:41:52 +0200
committerMartin Braun <martin.braun@ettus.com>2014-07-22 21:38:47 +0200
commita9c3d8ff3bc31117309004c16860d18f26369311 (patch)
tree4566e2c2cf868bb471a6cc81e3148a3aef1b061a /docs/doxygen/other/components.dox
parentd09b971d01f4e65eff80065796d724d88168866d (diff)
docs: Restructured intro page, added some manual pages
Diffstat (limited to 'docs/doxygen/other/components.dox')
-rw-r--r--docs/doxygen/other/components.dox34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/doxygen/other/components.dox b/docs/doxygen/other/components.dox
new file mode 100644
index 0000000000..1e98beb6f2
--- /dev/null
+++ b/docs/doxygen/other/components.dox
@@ -0,0 +1,34 @@
+/*! \page page_components Components
+
+\section components_blocks GNU Radio Blocks
+
+GNU Radio uses discrete signal processing blocks that are connected
+together to perform your signal processing application. This manual
+contain a list of all GNU Radio <a href="modules.html"><b>C++ Blocks</b></a>,
+sorted by category.
+
+Please note that at this time, we haven't found an acceptable way to
+provide unified documentation for the C++ parts of the system and the
+parts written in Python (mostly hierarchical blocks). Until this gets
+worked out, please bear with us, or better yet, solve it for us!
+
+\section components_list In-tree components
+
+All our in-tree components have their own top-level documentation:
+
+\li \subpage page_analog
+\li \subpage page_audio
+\li \subpage page_blocks
+\li \subpage page_channels
+\li \subpage page_ctrlport
+\li \subpage page_digital
+\li \subpage page_fcd
+\li \subpage page_fec
+\li \subpage page_fft
+\li \subpage page_filter
+\li \subpage page_qtgui
+\li \subpage page_uhd
+\li \subpage page_vocoder
+\li \subpage page_zeromq
+
+*/