[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] [gnuradio] 01/04: blocks: add missing parameter docume
From: |
git |
Subject: |
[Commit-gnuradio] [gnuradio] 01/04: blocks: add missing parameter documentation in tag_share |
Date: |
Tue, 18 Apr 2017 00:20:31 +0000 (UTC) |
This is an automated email from the git hooks/post-receive script.
jcorgan pushed a commit to branch master
in repository gnuradio.
commit 6cb4957bc31eb649365b80df57e7124cb0e6bc9b
Author: Johnathan Corgan <address@hidden>
Date: Mon Apr 17 06:55:05 2017 -0700
blocks: add missing parameter documentation in tag_share
---
gr-blocks/include/gnuradio/blocks/tag_share.h | 15 +++++++--------
1 file changed, 7 insertions(+), 8 deletions(-)
diff --git a/gr-blocks/include/gnuradio/blocks/tag_share.h
b/gr-blocks/include/gnuradio/blocks/tag_share.h
index b2d288f..476076c 100644
--- a/gr-blocks/include/gnuradio/blocks/tag_share.h
+++ b/gr-blocks/include/gnuradio/blocks/tag_share.h
@@ -1,26 +1,25 @@
/* -*- c++ -*- */
-/*
+/*
* Copyright 2017 Free Software Foundation, Inc.
- *
+ *
* This file is part of GNU Radio
- *
+ *
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
- *
+ *
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
-
#ifndef INCLUDED_BLOCKS_TAG_SHARE_H
#define INCLUDED_BLOCKS_TAG_SHARE_H
@@ -40,7 +39,7 @@ namespace gr {
* useful when a signal is detected via a correlate_access_code_bb or
* a threshold crossing from a complex_to_mag_squared block. The tag from
* that detection is on the alternate stream, either bytes or floats.
- * Often there is further signal processing that should be done on the
+ * Often there is further signal processing that should be done on the
* complex stream. This block allows the detection tags to be added to
* the complex stream to trigger downstream processing without the need of
* redundant trigger inputs on all subsequent blocks.
@@ -57,6 +56,7 @@ namespace gr {
* stream type does not have to match the input/output stream type. Tags
from
* Input 1's items will be combined with Input 0's item tags and
outputted on
* Output 0.
+ * \param vlen The vector size of the input and output stream items
*/
static sptr make(size_t sizeof_io_item, size_t sizeof_share_item, size_t
vlen = 1);
};
@@ -65,4 +65,3 @@ namespace gr {
} // namespace gr
#endif /* INCLUDED_BLOCKS_TAG_SHARE_H */
-