diff options
| author |   Martin Braun <martin.braun@ettus.com> | 2020-10-07 10:47:37 +0200 |
|---|---|---|
| committer |   michael-west <michael.west@ettus.com> | 2020-10-07 11:27:21 -0700 |
| commit | 7361b47470f353384f4dacf92434072eee57f2dd (patch) | |
| tree | 1d71c3b6499e2ff79adb1433e93ec73f4f841e33 | |
| parent | debian: Update Python3 dependencies (diff) | |
| download | uhd-7361b47470f353384f4dacf92434072eee57f2dd.tar.xz uhd-7361b47470f353384f4dacf92434072eee57f2dd.zip | |
docs: Fix doxygen warnings
| -rw-r--r-- | host/docs/Doxyfile.in | 14 | ||||
| -rw-r--r-- | host/docs/build.dox.in | 3 | ||||
| -rw-r--r-- | host/docs/rd_testing.dox | 2 |
3 files changed, 3 insertions, 16 deletions
diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in index 36ae2208c..16e114d27 100644 --- a/host/docs/Doxyfile.in +++ b/host/docs/Doxyfile.in @@ -1650,11 +1650,6 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- @@ -1667,15 +1662,6 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. diff --git a/host/docs/build.dox.in b/host/docs/build.dox.in index 26791015c..84c14181a 100644 --- a/host/docs/build.dox.in +++ b/host/docs/build.dox.in @@ -225,7 +225,8 @@ extensions: want it to be (check the PYTHON_VERSION variable) - Open the CMake GUI. - Set the path to the source code: `<uhd-repo-path>/host`. -- Set the path to the build directory (this may require creating the folder \build\): `<uhd-repo-path>/host/build`. +- Set the path to the build directory (this may require creating the folder "build"): + `<uhd-repo-path>/host/build`. - Make sure that the paths do not contain spaces. - Check the Advanced checkbox. - Click "Configure". diff --git a/host/docs/rd_testing.dox b/host/docs/rd_testing.dox index dcdf310f7..e31973c5e 100644 --- a/host/docs/rd_testing.dox +++ b/host/docs/rd_testing.dox @@ -188,7 +188,7 @@ installed. The radio test bench resides in `<fpga-dir>/usrp3/lib/radio/noc_block_radio_core_tb/`. 4. Device specific test benches: - IPs specific to a device have test benches that exist in `<fpga-dir>/usrp3/top/x300/sim/*`. e.g. DMA testbench, PCIe, etc. + IPs specific to a device have test benches that exist in `<fpga-dir>/usrp3/top/x300/sim/`. e.g. DMA testbench, PCIe, etc. 2. Setup the environment by running `source <fpga-dir>/usrp3/top/<device>/setupenv.sh`. |