core: added comment on how to cache parameters

mavlink · Jul 19, 2018 · 0f47a71 · 0f47a71
1 parent ea3bd11
commit 0f47a71
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/core/system_impl.h b/core/system_impl.h
@@ -142,6 +142,8 @@ class SystemImpl {
     std::pair<bool, float> get_param_ext_float(const std::string &name);
     std::pair<bool, int> get_param_ext_int(const std::string &name);
 
+    // These methods can be used to cache a parameter when a system connects. For that
+    // the callback can just be set to nullptr.
     void get_param_float_async(const std::string &name, get_param_float_callback_t callback);
     void get_param_int_async(const std::string &name, get_param_int_callback_t callback);
     void get_param_ext_float_async(const std::string &name, get_param_float_callback_t callback);