diff options
author | Martin Braun <martin.braun@ettus.com> | 2015-10-08 14:03:21 -0700 |
---|---|---|
committer | Martin Braun <martin.braun@ettus.com> | 2015-10-08 14:03:21 -0700 |
commit | f567b5d818697a5c8fdc9031563fa124329a6768 (patch) | |
tree | c9ae20b561ca66393527bc68067c9818cf3dcaa0 /host/include | |
parent | c7564bc99e8a1b72af1cef61d4fbde182fc55da7 (diff) | |
download | uhd-f567b5d818697a5c8fdc9031563fa124329a6768.tar.gz uhd-f567b5d818697a5c8fdc9031563fa124329a6768.tar.bz2 uhd-f567b5d818697a5c8fdc9031563fa124329a6768.zip |
docs: Removed some Doxygen warnings
Diffstat (limited to 'host/include')
-rw-r--r-- | host/include/uhd/transport/vrt_if_packet.hpp | 8 |
1 files changed, 4 insertions, 4 deletions
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` |