From 6ffe0cc5c8015ce581c9d689c07abb0de294f30e Mon Sep 17 00:00:00 2001 From: Brent Stapleton Date: Thu, 1 Feb 2018 14:31:57 -0800 Subject: mpmd: components: Add doxygen for update component Adding doxygen comment for _update_component in mpmd. --- host/lib/usrp/mpmd/mpmd_prop_tree.cpp | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'host/lib/usrp') diff --git a/host/lib/usrp/mpmd/mpmd_prop_tree.cpp b/host/lib/usrp/mpmd/mpmd_prop_tree.cpp index 33ffde401..64e68c486 100644 --- a/host/lib/usrp/mpmd/mpmd_prop_tree.cpp +++ b/host/lib/usrp/mpmd/mpmd_prop_tree.cpp @@ -20,6 +20,12 @@ namespace { //! Timeout value for the update_component RPC call (ms) constexpr size_t MPMD_UPDATE_COMPONENT_TIMEOUT = 20000; + /*! Update a component using all required files. For example, when updating the FPGA image + * (.bit or .bin), users can provide a new overlay image (DTS) to apply in addition. + * + * \param comps Vector of component files to be updated + * \param mb Reference to the actual device + */ uhd::usrp::component_files_t _update_component( const uhd::usrp::component_files_t& comps, mpmd_mboard_impl *mb -- cgit v1.2.3