[doc]: update comments

orbbec · Mar 22, 2024 · 4bdbf70 · 4bdbf70
1 parent cc9608a
commit 4bdbf70
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/include/k4a/k4a.h b/include/k4a/k4a.h
@@ -83,6 +83,10 @@ K4A_EXPORT k4a_result_t k4a_device_enable_soft_filter(k4a_device_t device_handle
  *
  * \remarks This API is used for device clock synchronization mode switching.
  *
+ * \remarks It is necessary to ensure that the mode switching of all devices is completed before any device start_cameras.
+ *
+ * \remarks It is necessary to ensure that the master and slave devices are configured in the same mode.
+ *
  * \xmlonly
  * <requirements>
  *   <requirement name="Header">k4a.h (include k4a/k4a.h)</requirement>