Note: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
m (add info)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Used to add a note/comment to a flowgraph. Alternatively, you can just use the "Comment" field in the Advanced tab of <b>any</b> block to add a better looking, much longer note. The comments will only show on the flowgraph if the View -> 'Show Block Comments' is checked. If the block is disabled, the comment will not be shown.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary. Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Note
: Title in the Note block. If it is longer than 23 characters, three dots will show in the middle of the text to represent omitted characters.


; Param 1 (''R'')
== Example Flowgraph ==
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
 
; Param 2
: blah blah blah


== Example Flowgraph ==
A Note block can be used to annotate special information on a flowgraph.


Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI.  Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately.  The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
[[File:RTTY_rcv.png|700px]]


== Source Files ==
== Source Files ==
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/grc/blocks/note.block.yml]

Latest revision as of 01:51, 18 November 2020

Used to add a note/comment to a flowgraph. Alternatively, you can just use the "Comment" field in the Advanced tab of any block to add a better looking, much longer note. The comments will only show on the flowgraph if the View -> 'Show Block Comments' is checked. If the block is disabled, the comment will not be shown.

Parameters

Note
Title in the Note block. If it is longer than 23 characters, three dots will show in the middle of the text to represent omitted characters.

Example Flowgraph

A Note block can be used to annotate special information on a flowgraph.

RTTY rcv.png

Source Files

Block definition
[1]
Retrieved from "https://wiki.gnuradio.org/index.php?title=Note&oldid=7765"