Fix docs

Signed-off-by: Michael Carroll <[email protected]>
gazebosim · Oct 4, 2023 · 1efc181 · 1efc181
1 parent 086a066
commit 1efc181
Showing 1 changed file with 18 additions and 6 deletions.
diff --git a/test/integration/implptr/implptr_test_classes.hh b/test/integration/implptr/implptr_test_classes.hh
@@ -35,19 +35,23 @@ namespace gz
     class GZ_UTILS_VISIBLE CopyableObject
     {
       /// \brief Constructor
+      /// \param _ivalue Initial value of the stored integer
+      /// \param _svalue Initial value of the stored string
       public: CopyableObject(int _ivalue = 0,
                              const std::string &_svalue = "");
 
       /// \brief Get the int value held by the pimpl
-      public: int GetInt() const;
+      public: [[nodiscard]] int GetInt() const;
 
       /// \brief Set the int value held by the pimpl
+      /// \param _value Integer value to set
       public: void SetInt(int _value);
 
       /// \brief Get the string value held by the pimpl
-      public: const std::string &GetString() const;
+      public: [[nodiscard]] const std::string &GetString() const;
 
       /// \brief Set the string value held by the pimpl
+      /// \param _value String value to set
       public: void SetString(const std::string &_value);
 
       /// \brief Uses a thread to increment the internal integer value from
@@ -65,19 +69,23 @@ namespace gz
     class GZ_UTILS_VISIBLE MovableObject
     {
       /// \brief Constructor
+      /// \param _ivalue Initial value of the stored integer
+      /// \param _svalue Initial value of the stored string
       public: MovableObject(int _ivalue = 0,
                             const std::string &_svalue = "");
 
       /// \brief Get the int value held by the pimpl
-      public: int GetInt() const;
+      public: [[nodiscard]] int GetInt() const;
 
       /// \brief Set the int value held by the pimpl
+      /// \param _value Integer value to set
       public: void SetInt(int _value);
 
       /// \brief Get the string value held by the pimpl
-      public: const std::string &GetString() const;
+      public: [[nodiscard]] const std::string &GetString() const;
 
       /// \brief Set the string value held by the pimpl
+      /// \param _value String value to set
       public: void SetString(const std::string &_value);
 
       /// \brief Uses a thread to increment the internal integer value from
@@ -95,19 +103,23 @@ namespace gz
     class GZ_UTILS_VISIBLE CopyableObjectAlt
     {
       /// \brief Constructor
+      /// \param _ivalue Initial value of the stored integer
+      /// \param _svalue Initial value of the stored string
       public: CopyableObjectAlt(int _ivalue = 0,
                                 const std::string &_svalue = "");
 
       /// \brief Get the int value held by the pimpl
-      public: int GetInt() const;
+      public: [[nodiscard]] int GetInt() const;
 
       /// \brief Set the int value held by the pimpl
+      /// \param _value Integer value to set
       public: void SetInt(int _value);
 
       /// \brief Get the string value held by the pimpl
-      public: const std::string &GetString() const;
+      public: [[nodicard]] const std::string &GetString() const;
 
       /// \brief Set the string value held by the pimpl
+      /// \param _value String value to set
       public: void SetString(const std::string &_value);
 
       /// \brief Pointer to implementation