aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/block_desc_files.dox
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2018-06-21 12:26:17 +0100
committerMartin Braun <martin.braun@ettus.com>2018-06-22 09:11:23 -0700
commit5c5c7ed760fc5eb498f526258d7c474e80379463 (patch)
treec2bcf8f0e2f34632f9520eda3b3ace1cd8840e5e /host/docs/block_desc_files.dox
parentcb690f0a88faf203aaabddbb5bcb0293115972de (diff)
downloaduhd-5c5c7ed760fc5eb498f526258d7c474e80379463.tar.gz
uhd-5c5c7ed760fc5eb498f526258d7c474e80379463.tar.bz2
uhd-5c5c7ed760fc5eb498f526258d7c474e80379463.zip
Docs: Add stub of RFNoC docs
Diffstat (limited to 'host/docs/block_desc_files.dox')
-rw-r--r--host/docs/block_desc_files.dox16
1 files changed, 16 insertions, 0 deletions
diff --git a/host/docs/block_desc_files.dox b/host/docs/block_desc_files.dox
new file mode 100644
index 000000000..20f54e24a
--- /dev/null
+++ b/host/docs/block_desc_files.dox
@@ -0,0 +1,16 @@
+/*! \page page_rfnoc_descriptor_file RFNoC Block Descriptor Files
+
+
+\section rfnoc_descriptor_file_nocscript NocScript
+
+NocScript is a simple DSL designed to augment block definition files for RFNoC.
+
+\li Statically Typed
+\li No implicit typecasting
+\li Very few operators
+
+See \subpage page_nocscript_funcs for a full function reference.
+
+*/
+// vim:ft=doxygen:
+