doc comments

Author: lia-viam

src/viam/sdk/robot/client.cpp

@@ -108,6 +108,8 @@ struct RobotClient::impl {
 
     std::unique_ptr<RobotService::Stub> stub;
 
+    // See doc comment for RobotClient::connect_logging. This pointer is non-null and installed as a
+    // sink only for apps being run by viam-server as a module.
     boost::shared_ptr<viam::sdk::impl::SinkType> log_sink;
 };
 

src/viam/sdk/robot/client.hpp

@@ -170,6 +170,11 @@ class RobotClient {
              const std::string& message,
              time_pt time);
 
+    // Makes this RobotClient manage logging by sending logs over grpc to viam-server.
+    // This is private and only ever called by ModuleService; in other words it is only called when
+    // viam-server is running a Viam C++ SDK application as a module.
+    // Disables console logging so as to avoid log message duplication; console logging is
+    // re-enabled on destruction.
     void connect_logging();
 
     void refresh_every();