From 03d7a27cd52eadaad0a2407b30e41a371508ac32 Mon Sep 17 00:00:00 2001
From: Michael Carroll <mjcarroll@intrinsic.ai>
Date: Mon, 27 Nov 2023 14:54:13 +0000
Subject: [PATCH] Address reviewer feedback
Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>
---
log/test/integration/ChirpParams.cc | 15 +++------------
log/test/integration/ChirpParams.hh | 5 +++--
2 files changed, 6 insertions(+), 14 deletions(-)
diff --git a/log/test/integration/ChirpParams.cc b/log/test/integration/ChirpParams.cc
index 1f606f1d6..ba0a517d5 100644
--- a/log/test/integration/ChirpParams.cc
+++ b/log/test/integration/ChirpParams.cc
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2018 Open Source Robotics Foundation
+ * Copyright (C) 2023 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,22 +17,13 @@
#include "ChirpParams.hh"
+#include <string>
+#include <vector>
static constexpr const char* kTopicChirpExe = TOPIC_CHIRP_EXE;
namespace gz::transport::log::test
{
- //////////////////////////////////////////////////
- /// \brief Similar to testing::forkAndRun(), except this function
- /// specifically calls the INTEGRATION_topicChirp_aux process and passes
- /// it arguments to determine how it should chirp out messages over its
- /// topics.
- /// \param _topics A list of topic names to chirp on
- /// \param _chirps The number of messages to chirp out. Each message
- /// will count up starting from the value 1 and ending with the value
- /// _chirps.
- /// \return A handle to the process. This can be used with
- /// testing::waitAndCleanupFork().
gz::utils::Subprocess BeginChirps(
const std::vector<std::string> &_topics,
const int _chirps,
diff --git a/log/test/integration/ChirpParams.hh b/log/test/integration/ChirpParams.hh
index e194cac84..5331df5ab 100644
--- a/log/test/integration/ChirpParams.hh
+++ b/log/test/integration/ChirpParams.hh
@@ -46,10 +46,11 @@ namespace gz::transport::log::test
/// specifically calls the INTEGRATION_topicChirp_aux process and passes
/// it arguments to determine how it should chirp out messages over its
/// topics.
- /// \param _topics A list of topic names to chirp on
- /// \param _chirps The number of messages to chirp out. Each message
+ /// \param[in] _topics A list of topic names to chirp on
+ /// \param[in] _chirps The number of messages to chirp out. Each message
/// will count up starting from the value 1 and ending with the value
/// _chirps.
+ /// \param[in] _paritionName Gz transport partition to use for the test
/// \return A handle to the process. This can be used with
/// testing::waitAndCleanupFork().
gz::utils::Subprocess BeginChirps(