From f567b5d818697a5c8fdc9031563fa124329a6768 Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Thu, 8 Oct 2015 14:03:21 -0700 Subject: docs: Removed some Doxygen warnings --- host/docs/Doxyfile.in | 12 ------------ host/docs/dboards.dox | 2 +- host/docs/usrp_e3x0.dox | 2 +- host/docs/usrp_x3x0.dox | 2 +- host/include/uhd/transport/vrt_if_packet.hpp | 8 ++++---- 5 files changed, 7 insertions(+), 19 deletions(-) diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in index dc4966011..d984b6f6b 100644 --- a/host/docs/Doxyfile.in +++ b/host/docs/Doxyfile.in @@ -1472,18 +1472,6 @@ GENERATE_XML = NO XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that diff --git a/host/docs/dboards.dox b/host/docs/dboards.dox index 812a3a09e..a0188b25c 100644 --- a/host/docs/dboards.dox +++ b/host/docs/dboards.dox @@ -395,7 +395,7 @@ below, and to the left of **R193**. The silkscreen for **R193** is ok, but for **R194**, it is upside down, and partially cut off. If you lose **R193**, you can use anything from 0 to 10 Ohms there. -\subsubsection dboards_dbsrxmod_1 Step 2: Burn a new daughterboard id into the EEPROM +\subsubsection dboards_dbsrxmod_2 Step 2: Burn a new daughterboard id into the EEPROM With the daughterboard plugged-in, run the following commands: diff --git a/host/docs/usrp_e3x0.dox b/host/docs/usrp_e3x0.dox index 3c206195d..d49310c2c 100644 --- a/host/docs/usrp_e3x0.dox +++ b/host/docs/usrp_e3x0.dox @@ -215,7 +215,7 @@ again by: In order to upgrade or reinitialize a sd card for the first time, you can use the 'dd' tool. Make sure that you are using the right block device for your sd card as failing to do so can wipe your harddrive. -Replace .direct with your image file name and yoursdcard with your blockdevice e.g. /dev/mmcblk0 or /dev/sdb. +Replace ``.direct with your image file name and yoursdcard with your blockdevice e.g. /dev/mmcblk0 or /dev/sdb. $ sudo dd if=.direct of=/dev/ bs=1M diff --git a/host/docs/usrp_x3x0.dox b/host/docs/usrp_x3x0.dox index 766766c21..f57ec783d 100644 --- a/host/docs/usrp_x3x0.dox +++ b/host/docs/usrp_x3x0.dox @@ -530,7 +530,7 @@ When there is network traffic arriving at the Ethernet port, LEDs will light up. You can use this to make sure the network connection is correctly set up, e.g. by pinging the USRP and making sure the LEDs start to blink. -\section x3x0_hw Hardware Notes +\section x3x0_hw_notes Hardware Notes \subsection x3x0_hw_fpanel Front Panel diff --git a/host/include/uhd/transport/vrt_if_packet.hpp b/host/include/uhd/transport/vrt_if_packet.hpp index 1e54607c1..0150e7f13 100644 --- a/host/include/uhd/transport/vrt_if_packet.hpp +++ b/host/include/uhd/transport/vrt_if_packet.hpp @@ -97,7 +97,7 @@ namespace vrt{ * * \section vrt_pack_contract Packing contract * - * \subsection Requirements: + * \subsection vrt_pack_contract_reqs Requirements: * - packet_buff points to a valid address space with enough space to write * the entire buffer, regardless of its length. At the very least, it must * be able to hold an entire header. @@ -107,7 +107,7 @@ namespace vrt{ * value (e.g. if `has_sid` is true, `sid` contains a valid SID) * - `num_payload_bytes` and `num_payload_words32` are both set to the correct values * - * \subsection Result: + * \subsection vrt_pack_contract_res Result: * - `packet_buff` now points to a valid header that can be sent over the transport * without further modification * - The following members on `if_packet_info` are set: @@ -127,7 +127,7 @@ namespace vrt{ * * \section vrt_unpack_contract Unpacking contract * - * \subsection Requirements + * \subsection vrt_unpack_contract_reqs Requirements * - `packet_buff` points to a readable address space with a * CHDR packet, starting at the header. `packet_buff[0]` *must* always * point to a valid first word of the header. This implies that num_packet_words32 @@ -138,7 +138,7 @@ namespace vrt{ * readable words from this packet. * - `link_type` * - * \subsection Result + * \subsection vrt_unpack_contract_res Result * - `if_packet_info` now has the following values set to correct values: * - `packet_type` * - `num_payload_bytes` -- cgit v1.2.3