summaryrefslogtreecommitdiff
path: root/docs/doxygen/other
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/other')
-rw-r--r--docs/doxygen/other/group_defs.dox67
-rw-r--r--docs/doxygen/other/main_page.dox59
-rw-r--r--docs/doxygen/other/pfb_intro.dox3
3 files changed, 101 insertions, 28 deletions
diff --git a/docs/doxygen/other/group_defs.dox b/docs/doxygen/other/group_defs.dox
index 4aee49ec85..170465fa1c 100644
--- a/docs/doxygen/other/group_defs.dox
+++ b/docs/doxygen/other/group_defs.dox
@@ -8,32 +8,47 @@
* @{
*/
-/*! \defgroup container_blk Top Block and Hierarchical Block Base Classes */
-/*! \defgroup source_blk Signal Sources */
-/*! \defgroup sink_blk Signal Sinks */
-/*! \defgroup filter_blk Filters */
-/*! \defgroup math_blk Mathematics */
-/*! \defgroup modulation_blk Signal Modulation */
-/*! \defgroup demodulation_blk Signal Demodulation */
-/*! \defgroup coding_blk Information Coding and Decoding*/
-/*! \defgroup sync_blk Synchronization */
-/*! \defgroup eq_blk Equalization */
-/*! \defgroup converter_blk Type Conversions */
-/*! \defgroup level_blk Signal Level Control (AGC) */
-/*! \defgroup dft_blk Fourier Transform */
-/*! \defgroup wavelet_blk Wavelet Transform */
-/*! \defgroup ofdm_blk OFDM Blocks */
-/*! \defgroup pager_blk Pager Blocks */
-/*! \defgroup misc_blk Miscellaneous Blocks */
-/*! \defgroup slicedice_blk Slicing and Dicing Streams */
-/*! \defgroup vocoder_blk Voice Encoders and Decoders */
-/*! \defgroup digital Digital Modulation Blocks */
-/*! \defgroup analog Analog Communications Blocks */
-/*! \defgroup qtgui_blk QT Graphical Interfaces */
-/*! \defgroup uhd_blk UHD Interface */
-/*! \defgroup audio_blk Audio Interface */
-/*! \defgroup pfb_blk Polyphase Filterbank */
-/*! \defgroup snr_blk SNR estimators */
+/*! \defgroup container_blk Top Block and Hierarchical Block Base Classes */
+/*! \defgroup audio_blk Audio Signals */
+/*! \defgroup boolean_operators_blk Boolean Operators */
+/*! \defgroup byte_operators_blk Byte Operators */
+/*! \defgroup channel_models_blk Channel Models */
+/*! \defgroup channelizers_blk Channelizers */
+/*! \defgroup coding_blk Information Coding and Decoding */
+/*! \defgroup controlport_blk ControlPort */
+/*! \defgroup debug_tools_blk Debug Tools */
+/*! \defgroup deprecated_blk Deprecated */
+/*! \defgroup equalizers_blk Equalizers */
+/*! \defgroup error_coding_blk Error Coding and Decoding */
+/*! \defgroup fcd_blk FCD Interface */
+/*! \defgroup file_operators_blk File Operators */
+/*! \defgroup filter_blk Filters */
+/*! \defgroup fourier_analysis_blk Fourier Analysis */
+/*! \defgroup instrumentation_blk Instrumentation Tools */
+/*! \defgroup level_controllers_blk Level Controllers */
+/*! \defgroup math_operators_blk Math Operators */
+/*! \defgroup measurement_tools_blk Measurement Tools */
+/*! \defgroup message_tools_blk Message Tools */
+/*! \defgroup misc_blk Miscellaneous */
+/*! \defgroup modulators_blk Modulators and Demodulators */
+/*! \defgroup networking_tools_blk Netwroking Tools */
+/*! \defgroup noaa_blk NOAA Blocks */
+/*! \defgroup ofdm_blk OFDM Blocks */
+/*! \defgroup packet_operators_blk Packet/Frame Operators */
+/*! \defgroup peak_detectors_blk Peak Detectors */
+/*! \defgroup pager_blk Pager Blocks */
+/*! \defgroup qtgui_blk QT Graphical Interfaces */
+/*! \defgroup resamplers_blk Resamplers */
+/*! \defgroup stream_operators_blk Streams Operators */
+/*! \defgroup stream_tag_tools_blk Stream Tag Tools */
+/*! \defgroup symbol_coding_blk Symbol Coding */
+/*! \defgroup synchronizers_blk Synchronizers */
+/*! \defgroup trellis_coding_blk Trellis Coding */
+/*! \defgroup type_converters_blk Data Type Converters */
+/*! \defgroup uhd_blk UHD Interface */
+/*! \defgroup waveform_generators_blk Waveform Generators */
+/*! \defgroup wavelet_blk Wavelet Transforms */
+/*! \defgroup wxgui_blk WX Graphical Interfaces */
/*!
* \defgroup base_blk Base classes for GR Blocks
diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox
index 3ad9e68021..498e2f5803 100644
--- a/docs/doxygen/other/main_page.dox
+++ b/docs/doxygen/other/main_page.dox
@@ -406,4 +406,63 @@ configuration variable and the section and option names are in
uppercase. The value is the same format that would be used in the
config file itself.
+
+
+\section oot_config_page Out-of-Tree Configuration
+
+New as of 3.6.5.
+
+Using gr_modtool, each package comes with the ability to easily locate
+the gnuradio-core library using the 'find_package(GnuradioCore)' cmake
+command. This only locates that the library and include directories
+exist, which is enough for most simple projects.
+
+As projects become more complicated and start needing to rely on other
+GNU Radio components like gnuradio-blocks or gnuradio-filter, for
+example, and when they become dependent on certain API compatibility
+versions of GNU Radio, we need something more. And so we have
+introduced the GnuradioConfig.cmake file.
+
+When GNU Radio is installed, it also installs a GNU Radio-specific
+cmake config file that we can use for more advanced compatibility
+issues of our projects. This tool allows us to specific the API
+compatible version and a set of components that are required.
+
+Taking the above example, say we have built against version 3.6.5 with
+features that were introduced in this version and we need the blocks
+and filter components as well as the main core library. We fist set a
+cmake variable GR_REQUIRED_COMPONENTS to the components we need. We
+then use the 'find_package' command and also set a minimum required
+API compatible version. Since we are on the 3.6 API version, the
+minimum required version is "3.6.5". The code in the CMakeLists.txt
+file would look like this:
+
+\code
+ set(GR_REQUIRED_COMPONENTS RUNTIME BLOCKS FILTER)
+ find_package(Gnuradio 3.6.5)
+\endcode
+
+Note that the capitalization is important on both lines.
+
+If the installed version of GNU Radio is 3.6.4 or some other API
+version like 3.5 or 3.7, the Cmake configuration will fail with the
+version error. Likewise, if libgnuradio-filter was not installed as
+part of GNU Radio, the configuration will also fail.
+
+\subsection oot_config_path_page Install Path
+
+Cmake has to know where to find these configuration files. They are
+installed into $prefix/lib/cmake/gnuradio. If $prefix is '/usr' or
+'/usr/local', then everything should work fine. If the GNU Radio
+install $prefix is something else, then Cmake must be told where to
+find it. This can be done in two ways. If you are installing the
+out-of-tree module into the same $prefix, then you would be setting
+'-DCMAKE_INSTALL_PREFIX' on the configuration command line. This is
+enough to tell Cmake where to look for the configuration files.
+
+The other way to do it is to set the CMAKE_PREFIX_PATH environmental
+variable to $prefix. You can then install your component anywhere
+you'd like and it will be able to find and configure against the
+installed GNU Radio.
+
*/
diff --git a/docs/doxygen/other/pfb_intro.dox b/docs/doxygen/other/pfb_intro.dox
index 1ef0c38f6d..d3c3ee63be 100644
--- a/docs/doxygen/other/pfb_intro.dox
+++ b/docs/doxygen/other/pfb_intro.dox
@@ -5,8 +5,7 @@
Polyphase filterbanks (PFB) are a very powerful set of filtering tools
that can efficiently perform many multi-rate signal processing
tasks. GNU Radio has a set of polyphase filterbank blocks to be used
-in all sorts of applications. These blocks and their documentation can
-be found in \ref pfb_blk.
+in all sorts of applications.
\section Usage