From 1ce81da1d27565049d83b309213de7427a8e4f25 Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Thu, 24 Feb 2022 11:04:39 +0100 Subject: docs: Fix Doxygen warnings - Removed variables that have been deprecated in newer Doxygen versions - Replaced with $speedgrade in E310 manual; Doxygen thinks it's an HTML tag. --- host/docs/Doxyfile.in | 15 +-------------- host/docs/usrp_e3xx.dox | 8 ++++---- 2 files changed, 5 insertions(+), 18 deletions(-) diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in index 2a15c1cf6..4d8e8306b 100644 --- a/host/docs/Doxyfile.in +++ b/host/docs/Doxyfile.in @@ -264,12 +264,6 @@ TAB_SIZE = 8 ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -1137,13 +1131,6 @@ VERBATIM_HEADERS = YES ALPHABETICAL_INDEX = NO -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored @@ -1792,7 +1779,7 @@ COMPACT_LATEX = NO # The default value is: a4. # This tag requires that the tag GENERATE_LATEX is set to YES. -PAPER_TYPE = a4wide +PAPER_TYPE = a4 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names # that should be included in the LaTeX output. The package can be specified just diff --git a/host/docs/usrp_e3xx.dox b/host/docs/usrp_e3xx.dox index f13708925..82daee7d5 100644 --- a/host/docs/usrp_e3xx.dox +++ b/host/docs/usrp_e3xx.dox @@ -100,7 +100,7 @@ This makes it easier to identify devices. You can change the hostname by modifyi `/etc/hostname` file and rebooting. 2. "product" name: -The "product" name for E310 is now "e310_" i.e. e310_sg1 and e310_sg3 for speed grade 1 +The "product" name for E310 is now "e310_$speedgrade" i.e. e310_sg1 and e310_sg3 for speed grade 1 and 3 respectively. Note that the "type" for e310 remains the same as before i.e. "e3xx". 3. FPGA bit/bin/rpt file name and image target: @@ -114,9 +114,9 @@ and 3 respectively. Note that the "type" for e310 remains the same as before i.e The names of the FPGA build targets have been modified but the old FPGA targets would continue to work as before. The generated bit files names in the build directory will be new as mentioned above. - - E310_ for default image - - E310__RFNOC for RFNOC image (contains a few blocks) - - E310__IDLE to build idle image (Doesn't need to modified for most cases) + - E310_$speedgrade for default image + - E310_$speedgrade_RFNOC for RFNOC image (contains a few blocks) + - E310_$speedgrade_IDLE to build idle image (Doesn't need to modified for most cases) 4. Loading FPGA image: The device arg "fpga=" can now only be used in the uhd_image_loader; it can no longer be used to -- cgit v1.2.3