summaryrefslogtreecommitdiff
path: root/gr-blocks/include/blocks/wavfile.h
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-04-03 19:33:32 -0400
committerTom Rondeau <trondeau@vt.edu>2013-04-04 10:38:29 -0400
commitd44322fd03661c1eb6e45e3e364e81bb5131239b (patch)
tree17c068dc4081f9bbdeaeb046ca20ee53794b2e27 /gr-blocks/include/blocks/wavfile.h
parent9ce3e6b3f658b9273f048e1a3580be65dc08bef1 (diff)
docs: updating Doxygen categories for all blocks.
Block categories in Doxygen now match where they are in GRC's category tree.
Diffstat (limited to 'gr-blocks/include/blocks/wavfile.h')
-rw-r--r--gr-blocks/include/blocks/wavfile.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/gr-blocks/include/blocks/wavfile.h b/gr-blocks/include/blocks/wavfile.h
index 690f8fc22a..b1993fa85a 100644
--- a/gr-blocks/include/blocks/wavfile.h
+++ b/gr-blocks/include/blocks/wavfile.h
@@ -55,6 +55,7 @@ namespace gr {
/*!
* \brief Read one sample from an open WAV file at the current position.
*
+ * \details
* Takes care of endianness.
*/
short int
@@ -77,6 +78,7 @@ namespace gr {
/*!
* \brief Write one sample to an open WAV file at the current position.
*
+ * \details
* Takes care of endianness.
*/
void
@@ -86,6 +88,7 @@ namespace gr {
/*!
* \brief Complete a WAV header
*
+ * \details
* Note: The stream position is changed during this function. If
* anything needs to be written to the WAV file after calling this
* function (which shouldn't happen), you need to fseek() to the