Skip to content

Commit 0e2bb78

Browse files
committed
document refresh
1 parent c89c7f4 commit 0e2bb78

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/viam/sdk/robot/client.hpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,12 @@ class RobotClient {
7575

7676
~RobotClient();
7777

78+
/// @brief Call out to the robot to see if there are any new resources that need to be
79+
/// registered. Compares the currently registered resources to the ones from the robot, seeing
80+
/// if any updates have been made. If so, they are registered and updated in @ref
81+
/// ResourceManager. This method can be called manually, or it will be called periodically and
82+
/// automatically if a positive refresh_interval is passed in the Options of the named
83+
/// constructors.
7884
void refresh();
7985

8086
/// @brief Disconnect this robot client from any robot to which it is connected.

0 commit comments

Comments
 (0)