From 9a3c84d6d1d6d76a62b35fd9ab04d31a0ca8178b Mon Sep 17 00:00:00 2001 From: Michel Hidalgo Date: Wed, 10 Aug 2022 08:50:33 -0300 Subject: [PATCH] Add missing documentation Signed-off-by: Michel Hidalgo --- io/include/gz/common/DataFrame.hh | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/io/include/gz/common/DataFrame.hh b/io/include/gz/common/DataFrame.hh index 5d502b8ca..b5a124dc6 100644 --- a/io/include/gz/common/DataFrame.hh +++ b/io/include/gz/common/DataFrame.hh @@ -41,19 +41,28 @@ namespace gz template class DataFrame { - /// \brief Check if column key is present. + /// \brief Check if column is present. + /// \param[in] _key Key to column to look up. + /// \return whether the given column is present + /// in the data frame. public: bool Has(const K &_key) const { return this->storage.count(_key) > 0; } - /// \brief Fetch mutable reference to column + /// \brief Fetch mutable reference to column. + /// \param[in] _key Key to column to look up. + /// \return Mutable reference to column in the + /// data frame. public: V &operator[](const K &_key) { return this->storage[_key]; } /// \brief Fetch immutable reference to column + /// \param[in] _key Key to column to look up. + /// \return Immutable reference to column in the + /// data frame. public: const V &operator[](const K &_key) const { return this->storage.at(_key);