diff options
Diffstat (limited to 'docs/doxygen')
25 files changed, 737 insertions, 25 deletions
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index 5782513d27..8d06249abb 100644 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -704,7 +704,8 @@ WARN_LOGFILE = # with spaces. INPUT = @top_srcdir@ \ - @top_builddir@ + @top_builddir@ \ + @top_srcdir@/docs/doxygen/other/license.dox # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/docs/doxygen/other/LICENSE.html b/docs/doxygen/other/LICENSE.html new file mode 100644 index 0000000000..a279a5f120 --- /dev/null +++ b/docs/doxygen/other/LICENSE.html @@ -0,0 +1,490 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>GNU Free Documentation License v1.3 - GNU Project - Free Software Foundation (FSF)</title> + <link rel="alternate" type="application/rdf+xml" + href="http://www.gnu.org/licenses/fdl-1.3.rdf" /> +</head> +<body> + +<h3 style="text-align: center;">GNU Free Documentation License</h3> + +<p style="text-align: center;">Version 1.3, 3 November 2008</p> + +<p> Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + <<a href="http://fsf.org/">http://fsf.org/</a>> + </p><p>Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed.</p> + +<h4><a name="section0"></a>0. PREAMBLE</h4> + +<p>The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others.</p> + +<p>This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software.</p> + +<p>We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference.</p> + +<h4><a name="section1"></a>1. APPLICABILITY AND DEFINITIONS</h4> + +<p>This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law.</p> + +<p>A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language.</p> + +<p>A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them.</p> + +<p>The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none.</p> + +<p>The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words.</p> + +<p>A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque".</p> + +<p>Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only.</p> + +<p>The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text.</p> + +<p>The "publisher" means any person or entity that distributes copies of +the Document to the public.</p> + +<p>A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition.</p> + +<p>The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License.</p> + +<h4><a name="section2"></a>2. VERBATIM COPYING</h4> + +<p>You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no +other conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3.</p> + +<p>You may also lend copies, under the same conditions stated above, and +you may publicly display copies.</p> + +<h4><a name="section3"></a>3. COPYING IN QUANTITY</h4> + +<p>If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects.</p> + +<p>If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages.</p> + +<p>If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public.</p> + +<p>It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to +give them a chance to provide you with an updated version of the +Document.</p> + +<h4><a name="section4"></a>4. MODIFICATIONS</h4> + +<p>You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version:</p> + +<ul> + + +<li>A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +</li> + +<li>B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +</li> + +<li>C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +</li> + +<li>D. Preserve all the copyright notices of the Document. +</li> + +<li>E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +</li> + +<li>F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +</li> + +<li>G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +</li> + +<li>H. Include an unaltered copy of this License. +</li> + +<li>I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +</li> + +<li>J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +</li> + +<li>K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +</li> + +<li>L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +</li> + +<li>M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +</li> + +<li>N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +</li> + +<li>O. Preserve any Warranty Disclaimers.</li> + +</ul> + +<p>If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles.</p> + +<p>You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties—for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard.</p> + +<p>You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one.</p> + +<p>The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version.</p> + +<h4><a name="section5"></a>5. COMBINING DOCUMENTS</h4> + +<p>You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers.</p> + +<p>The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work.</p> + +<p>In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements".</p> + +<h4><a name="section6"></a>6. COLLECTIONS OF DOCUMENTS</h4> + +<p>You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the rules +of this License for verbatim copying of each of the documents in all +other respects.</p> + +<p>You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert a +copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document.</p> + +<h4><a name="section7"></a>7. AGGREGATION WITH INDEPENDENT WORKS</h4> + +<p>A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document.</p> + +<p>If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate.</p> + +<h4><a name="section8"></a>8. TRANSLATION</h4> + +<p>Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail.</p> + +<p>If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title.</p> + +<h4><a name="section9"></a>9. TERMINATION</h4> + +<p>You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License.</p> + +<p>However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation.</p> + +<p>Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice.</p> + +<p>Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it.</p> + +<h4><a name="section10"></a>10. FUTURE REVISIONS OF THIS LICENSE</h4> + +<p>The Free Software Foundation may publish new, revised versions of the +GNU Free Documentation License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. See +<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.</p> + +<p>Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document.</p> + +<h4><a name="section11"></a>11. RELICENSING</h4> + +<p>"Massive Multiauthor Collaboration Site" (or "MMC Site") means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +"Massive Multiauthor Collaboration" (or "MMC") contained in the site +means any set of copyrightable works thus published on the MMC site.</p> + +<p>"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization.</p> + +<p>"Incorporate" means to publish or republish a Document, in whole or in +part, as part of another Document.</p> + +<p>An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole or +in part into the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008.</p> + +<p>The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing.</p> + +<h3><a name="addendum"></a>ADDENDUM: How to use this License for your documents</h3> + +<p>To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page:</p> + +<pre> Copyright (C) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". +</pre> + +<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with … Texts." line with this:</p> + +<pre> with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. +</pre> + +<p>If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation.</p> + +<p>If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +</p> + +</body></html> diff --git a/docs/doxygen/other/build_guide.dox b/docs/doxygen/other/build_guide.dox index 8fc3f911fb..f3bea608a4 100644 --- a/docs/doxygen/other/build_guide.dox +++ b/docs/doxygen/other/build_guide.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page build_guide Build Instructions and Information \section dependencies Dependencies diff --git a/docs/doxygen/other/components.dox b/docs/doxygen/other/components.dox index 564085fc80..b1f88d20b6 100644 --- a/docs/doxygen/other/components.dox +++ b/docs/doxygen/other/components.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_components Components \section components_blocks GNU Radio Blocks diff --git a/docs/doxygen/other/ctrlport.dox b/docs/doxygen/other/ctrlport.dox index fc0ac70320..d5ba8fdefc 100644 --- a/docs/doxygen/other/ctrlport.dox +++ b/docs/doxygen/other/ctrlport.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_ctrlport ControlPort \section ctrlport_introduction Introduction diff --git a/docs/doxygen/other/group_defs.dox b/docs/doxygen/other/group_defs.dox index 428ac9a8f3..8edc8ab5ef 100644 --- a/docs/doxygen/other/group_defs.dox +++ b/docs/doxygen/other/group_defs.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! * \defgroup block GNU Radio C++ Signal Processing Blocks * \brief All C++ blocks that can be used in GR graphs are listed here or in diff --git a/docs/doxygen/other/license.dox b/docs/doxygen/other/license.dox new file mode 100644 index 0000000000..d1c511a614 --- /dev/null +++ b/docs/doxygen/other/license.dox @@ -0,0 +1,15 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + +/*! \page License + +\htmlinclude ./LICENSE.html + +*/ + diff --git a/docs/doxygen/other/logger.dox b/docs/doxygen/other/logger.dox index f057e59d9b..ae6a744d00 100644 --- a/docs/doxygen/other/logger.dox +++ b/docs/doxygen/other/logger.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_logger Logging \section logging Logging diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox index 67487ddfd6..fede4524fd 100644 --- a/docs/doxygen/other/main_page.dox +++ b/docs/doxygen/other/main_page.dox @@ -1,15 +1,24 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \mainpage \image html gnuradio-logo.svg -Welcome to GNU Radio! +<H1> Welcome to GNU Radio! </H1> For details about GNU Radio and using it, please see the <a href="http://gnuradio.org" target="_blank"><b>main project page</b></a>. Other information about the project and discussion about GNU Radio, software radio, and communication theory in general can be found at -the <a href="http://www.trondeau.com" target="_blank"><b>GNU Radio blog</b></a>. +the <a href="http://www.gnuradio.org/blog" target="_blank"><b>GNU Radio blog</b></a>. This manual is split into two parts: A usage manual and a reference. The usage manual deals with concepts of GNU Radio, introductions, how to build GNU Radio etc. @@ -22,4 +31,13 @@ A search function is also available at the top right. \li \subpage page_usage "Part I - GNU Radio Usage" \li \subpage page_components "Part II - Reference" +<H3> Documentation License </H3> + +The Free Software Foundation gives permission to use and distribute +the program source documentation strings, after processing them +through Doxygen or some comparable program, under the GNU Free +Documentation License, version 1.3 or later. However, we do not grant +such permission for the program code in our release (aside from the +documentation strings). + */ diff --git a/docs/doxygen/other/metadata.dox b/docs/doxygen/other/metadata.dox index 4958e08aaa..b58d2a6aee 100644 --- a/docs/doxygen/other/metadata.dox +++ b/docs/doxygen/other/metadata.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_metadata Metadata Information \section metadata_introduction Introduction @@ -5,9 +14,8 @@ Metadata files have extra information in the form of headers that carry metadata about the samples in the file. Raw, binary files carry no extra information and must be handled delicately. Any changes in -the system state such as sample rate or if a receiver's frequency are -not conveyed with the data in the file itself. Header of metadata -solve this problem. +the system state such as a receiver's sample rate or frequency are +not conveyed with the data in the file itself. Headers solve this problem. We write metadata files using gr::blocks::file_meta_sink and read metadata files using gr::blocks::file_meta_source. @@ -26,14 +34,14 @@ information. - version: (char) version number (usually set to METADATA_VERSION) - rx_rate: (double) Stream's sample rate - rx_time: (pmt::pmt_t pair - (uint64_t, double)) Time stamp (format from UHD) -- size: (int) item size in bytes - reflects vector length if any. +- size: (int) item size in bytes - reflects vector length if any - type: (int) data type (enum below) - cplx: (bool) true if data is complex - strt: (uint64_t) start of data relative to current header - bytes: (uint64_t) size of following data segment in bytes An optional extra section of the header stores information in any -received tags. The two main tags associated with tags are: +received tags. The two main tags associated with headers are: - rx_rate: the sample rate of the stream. - rx_time: the time stamp of the first item in the segment. @@ -42,15 +50,15 @@ These tags were inspired by the UHD tag format. The header gives enough information to process and handle the data. One cautionary note, though, is that the data type should never -change within a file. There should be very little need for this, but -more importantly. GNU Radio blocks can only set the data type of their +change within a file. There should be very little need for this, because +GNU Radio blocks can only set the data type of their IO signatures in the constructor, so changes in the data type afterward will not be recognized. -We also have an extra header segment that is option. This can be +We also have an extra header segment that is optional. This can be loaded up at the beginning by the user specifying some extra metadata that should be transmitted along with the data. It also grows whenever -it sees a stream tag, so the dictionary will contain and key:value +it sees a stream tag, so the dictionary will contain any key:value pairs out of tags from the flowgraph. @@ -105,7 +113,7 @@ Metadata files are created using gr::blocks::file_meta_sink. The default behavior is to create a single file with inline headers as metadata. An option can be set to switch to detached header mode. -Metadata file are read into a flowgraph using +Metadata files are read into a flowgraph using gr::blocks::file_meta_source. This source reads a metadata file, inline by default with a settable option to use detached headers. The data from the segments is converted into a standard streaming @@ -123,7 +131,7 @@ dictionary. Headers are created by building a PMT dictionary serialized into a string to be written to file. The header is always the same length that is predetermined by the version of the header (this must be known already). The header will then indicate if there -is an extra data to be extracted as a separate serialized dictionary. +is extra data to be extracted as a separate serialized dictionary. To work with the PMTs for creating and extracting header information, we use PMT operators. For example, we create a simplified version of @@ -252,7 +260,7 @@ data type of the PMT value. The key is always a PMT symbol, but the value can be any other PMT type. There are PMT functions that allow us to query the PMT to test if it is a particular type. We also have the ability to do pmt::print on any PMT object to print it to -screen. Before converting from a PMT to it's natural data type, it is +screen. Before converting from a PMT to its natural data type, it is necessary to know the data type. @@ -318,7 +326,7 @@ vectors of data. The following shows a simple way of creating extra metadata for a metadata file. This example is just showing how we can insert a date -into the metadata to keep track of later. The date in this case is +into the metadata to keep track of it later. The date in this case is encoded as a vector of uint16 with [day, month, year]. \code diff --git a/docs/doxygen/other/msg_passing.dox b/docs/doxygen/other/msg_passing.dox index 494ca03921..827ad4ee62 100644 --- a/docs/doxygen/other/msg_passing.dox +++ b/docs/doxygen/other/msg_passing.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_msg_passing Message Passing \section msg_passing_introduction Introduction diff --git a/docs/doxygen/other/ofdm.dox b/docs/doxygen/other/ofdm.dox index 9a3a18fab8..77d80a7441 100644 --- a/docs/doxygen/other/ofdm.dox +++ b/docs/doxygen/other/ofdm.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_ofdm OFDM \section ofdm_introduction Introduction diff --git a/docs/doxygen/other/oot_config.dox b/docs/doxygen/other/oot_config.dox index bb441c5060..d07c7a2808 100644 --- a/docs/doxygen/other/oot_config.dox +++ b/docs/doxygen/other/oot_config.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_oot_config Out-of-Tree Configuration New as of 3.6.5. diff --git a/docs/doxygen/other/operating_fg.dox b/docs/doxygen/other/operating_fg.dox index b075ca648a..62cc56fd4e 100644 --- a/docs/doxygen/other/operating_fg.dox +++ b/docs/doxygen/other/operating_fg.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_operating_fg Handling flow graphs \section flowgraph Operating a Flowgraph @@ -13,7 +22,7 @@ between. A program must at least create a GNU Radio 'top_block', which represents the top-most structure of the flowgraph. The top blocks provide the overall control and hold methods such as 'start,' 'stop,' -and 'wait.' +and 'wait'. The general construction of a GNU Radio application is to create a gr_top_block, instantiate the blocks, connect the blocks together, and @@ -58,7 +67,7 @@ By default, GNU Radio runs a scheduler that attempts to optimize throughput. Using a dynamic scheduler, blocks in a flowgraph pass chunks of items from sources to sinks. The sizes of these chunks will vary depending on the speed of processing. For each block, the number -of items is can process is dependent on how much space it has in its +of items it can process is dependent on how much space it has in its output buffer(s) and how many items are available on the input buffer(s). @@ -144,8 +153,8 @@ latency. Limiting the size of the buffer may decrease performance. 4. The real buffer size is actually based on a minimum granularity of the system. Typically, this is a page size, which is typically 4096 bytes. This means that any buffer size that is specified with this -command will get rounded up to the nearest granularity (e.g., page) -size. When calling max_output_buffer(port) after the flowgraph is +command will get rounded up to the nearest granularity (e.g., page size). +When calling max_output_buffer(port) after the flowgraph is started, you will get how many items were actually allocated in the buffer, which may be different than what was initially specified. diff --git a/docs/doxygen/other/packet_txrx.dox b/docs/doxygen/other/packet_txrx.dox index 2a8aeae51e..c481e7e207 100644 --- a/docs/doxygen/other/packet_txrx.dox +++ b/docs/doxygen/other/packet_txrx.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_packet_data Packet Data Transmission \section packet_data_introduction Introduction diff --git a/docs/doxygen/other/perf_counters.dox b/docs/doxygen/other/perf_counters.dox index 9bca38268a..7562b11298 100644 --- a/docs/doxygen/other/perf_counters.dox +++ b/docs/doxygen/other/perf_counters.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_perf_counters Performance Counters \section pc_introduction Introduction diff --git a/docs/doxygen/other/pfb_intro.dox b/docs/doxygen/other/pfb_intro.dox index 43bea77777..83313e9568 100644 --- a/docs/doxygen/other/pfb_intro.dox +++ b/docs/doxygen/other/pfb_intro.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_pfb Polyphase Filterbanks \section pfb_introduction Introduction diff --git a/docs/doxygen/other/pmt.dox b/docs/doxygen/other/pmt.dox index 6805b27a8a..1bc6cbecd4 100644 --- a/docs/doxygen/other/pmt.dox +++ b/docs/doxygen/other/pmt.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_pmt Polymorphic Types \section pmt_introduction Introduction @@ -46,7 +55,7 @@ std::cout << P2 << std::endl; std::cout << pmt::is_complex(P2) << std::endl; \endcode -Two things stand out in both Python and C++: First we can simply print +Two things stand out in both Python and C++. First, we can simply print the contents of a PMT. How is this possible? Well, the PMTs have in-built capability to cast their value to a string (this is not possible with all types, though). Second, PMTs must obviously know @@ -74,9 +83,9 @@ std::string str = pmt::symbol_to_string(P_str); The pmt::intern is another way of saying pmt::string_to_symbol. -In Python, we can make use of the weak typing, and there's actually a +In Python, we can make use of the dynamic typing, and there's actually a helper function to do these conversions (C++ also has a helper -function for converting to PMTs called pmt::mp(), but its less +function for converting to PMTs called pmt::mp(), but it's less powerful, and not quite as useful, because types are always strictly known in C++): @@ -274,7 +283,7 @@ if(pmt::is_double(pmt_a)) \section pmt_dict Dictionaries -PMT dictionaries and lists of key:value pairs. They have a +PMT dictionaries are lists of key:value pairs. They have a well-defined interface for creating, adding, removing, and accessing items in the dictionary. Note that every operation that changes the dictionary both takes a PMT dictionary as an argument and returns a diff --git a/docs/doxygen/other/prefs.dox b/docs/doxygen/other/prefs.dox index 46f68c447e..d8c2782b1d 100644 --- a/docs/doxygen/other/prefs.dox +++ b/docs/doxygen/other/prefs.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_prefs Configuration files \section prefs Configuration / Preference Files diff --git a/docs/doxygen/other/python_blocks.dox b/docs/doxygen/other/python_blocks.dox index 49273cdcd8..2381b0cad0 100644 --- a/docs/doxygen/other/python_blocks.dox +++ b/docs/doxygen/other/python_blocks.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_python_blocks Python Blocks How to create blocks in Python @@ -151,4 +160,4 @@ class msg_block(gr.basic_block): pmt.intern('message received!')) \endcode -*/
\ No newline at end of file +*/ diff --git a/docs/doxygen/other/stream_tags.dox b/docs/doxygen/other/stream_tags.dox index 2af431b526..8edc598e96 100644 --- a/docs/doxygen/other/stream_tags.dox +++ b/docs/doxygen/other/stream_tags.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_stream_tags Stream Tags \section stream_tags_introduction Introduction diff --git a/docs/doxygen/other/tagged_stream_blocks.dox b/docs/doxygen/other/tagged_stream_blocks.dox index 4e75b29c6b..1a10483323 100644 --- a/docs/doxygen/other/tagged_stream_blocks.dox +++ b/docs/doxygen/other/tagged_stream_blocks.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_tagged_stream_blocks Tagged Stream Blocks \section tsb_introduction Introduction diff --git a/docs/doxygen/other/thread_affinity.dox b/docs/doxygen/other/thread_affinity.dox index edac813866..405477b8d3 100644 --- a/docs/doxygen/other/thread_affinity.dox +++ b/docs/doxygen/other/thread_affinity.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_affinity Block Thread Affinity and Priority \section affinity Block Thread Affinity diff --git a/docs/doxygen/other/usage.dox b/docs/doxygen/other/usage.dox index 717f14e610..2df378c670 100644 --- a/docs/doxygen/other/usage.dox +++ b/docs/doxygen/other/usage.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page page_usage Usage Manual Note: Once built, check out <a href="http://gnuradio.org" target="_blank">gnuradio.org</a> for diff --git a/docs/doxygen/other/volk_guide.dox b/docs/doxygen/other/volk_guide.dox index a6a24457a6..e5a55c1719 100644 --- a/docs/doxygen/other/volk_guide.dox +++ b/docs/doxygen/other/volk_guide.dox @@ -1,3 +1,12 @@ +# Copyright (C) 2017 Free Software Foundation, Inc. +# +# Permission is granted to copy, distribute and/or modify this document +# under the terms of the GNU Free Documentation License, Version 1.3 +# or any later version published by the Free Software Foundation; +# with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +# A copy of the license is included in the section entitled "GNU +# Free Documentation License". + /*! \page volk_guide Instructions for using VOLK in GNU Radio Note: Many blocks have already been converted to use VOLK in their calls, so |