Skip to content

Commit 9acb35e

Browse files
committed
added Doxygen comments for data package publisher
1 parent 4be7cc4 commit 9acb35e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

ur_robot_driver/include/ur_robot_driver/ros/data_package_publisher.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,21 @@ namespace ur_driver
3535
{
3636
namespace rtde_interface
3737
{
38+
/*!
39+
* \brief The DataPackagePublisher class handles publishing all data fields of an RTDE data
40+
* package to various ROS topics.
41+
*/
3842
class DataPackagePublisher
3943
{
4044
public:
4145
DataPackagePublisher() = delete;
4246

47+
/*!
48+
* \brief Creates a new DataPackagePublisher object.
49+
*
50+
* \param recipe The different data fields contained in the package that should be published
51+
* \param nh The node handle to advertise publishers on
52+
*/
4353
DataPackagePublisher(const std::vector<std::string>& recipe, ros::NodeHandle& nh) : recipe_(recipe)
4454
{
4555
for (auto str : recipe)
@@ -49,6 +59,11 @@ class DataPackagePublisher
4959
}
5060

5161
void publishData(const std::unique_ptr<DataPackage>& data_package)
62+
/*!
63+
* \brief Publishes all relevant data fields of a given data package.
64+
*
65+
* \param data_package The data package to publish
66+
*/
5267
{
5368
for (auto const& i : publishers_)
5469
{

0 commit comments

Comments
 (0)