Minor fixes to some comments

Signed-off-by: tempate <danieldiaz@eprosima.com>
eProsima · Dec 14, 2023 · 814fc16 · 814fc16
1 parent 43535e9
commit 814fc16
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/ddsrecorder/src/cpp/main.cpp b/ddsrecorder/src/cpp/main.cpp
@@ -216,7 +216,7 @@ int main(
 
             logUser(
                 DDSRECORDER_EXECUTION,
-                "Not configuration file given, using default file " << file_path << ".");
+                "No configuration file given, using default file " << file_path << ".");
         }
     }
     else

diff --git a/ddsrecorder_yaml/src/cpp/recorder/YamlReaderConfiguration.cpp b/ddsrecorder_yaml/src/cpp/recorder/YamlReaderConfiguration.cpp
@@ -128,10 +128,9 @@ void RecorderConfiguration::load_ddsrecorder_configuration_(
         ddspipe_configuration.blocklist.insert(
             utils::Heritable<WildcardDdsFilterTopic>::make_heritable(rpc_response_topic));
 
-        // The DDS Pipe should be enabled on start up.
         ddspipe_configuration.init_enabled = true;
 
-        // The recorder's DdsPipe trigger is the discovery of a writer
+        // Only trigger the DdsPipe's callbacks when discovering or removing writers
         ddspipe_configuration.discovery_trigger = DiscoveryTrigger::WRITER;
 
         // Initialize controller domain with the same as the one being recorded

diff --git a/ddsrecorder_yaml/src/cpp/replayer/YamlReaderConfiguration.cpp b/ddsrecorder_yaml/src/cpp/replayer/YamlReaderConfiguration.cpp
@@ -132,10 +132,9 @@ void ReplayerConfiguration::load_ddsreplayer_configuration_(
         ddspipe_configuration.blocklist.insert(
             utils::Heritable<WildcardDdsFilterTopic>::make_heritable(rpc_response_topic));
 
-        // The DDS Pipe should be enabled on start up.
         ddspipe_configuration.init_enabled = true;
 
-        // The replayer's DdsPipe doesn't get triggered by the discovery of entities
+        // Don't trigger the DdsPipe's callbacks when discovering or removing external entities
         ddspipe_configuration.discovery_trigger = DiscoveryTrigger::NONE;
     }
     catch (const std::exception& e)

diff --git a/ddsreplayer/src/cpp/tool/DdsReplayer.hpp b/ddsreplayer/src/cpp/tool/DdsReplayer.hpp
@@ -72,9 +72,9 @@ class DdsReplayer
     ~DdsReplayer();
 
     /**
-     * Reload allowed topics list.
+     * Reconfigure the Replayer with the new configuration.
      *
-     * @param allowed_topics: Allowed topics list to be loaded.
+     * @param new_configuration: The configuration to replace the previous configuration with.
      *
      * @return \c RETCODE_OK if allowed topics list has been updated correctly
      * @return \c RETCODE_NO_DATA if new allowed topics list is the same as the previous one