add comments to method

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
daixtrose · Oct 23, 2024 · f85e5b5 · f85e5b5
1 parent cd5ebf7
commit f85e5b5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/polymorphism/test/include/test_polymorphism/mocking.hpp b/polymorphism/test/include/test_polymorphism/mocking.hpp
@@ -12,6 +12,11 @@ struct Mock {
     std::list<std::string> collectedSetArguments;
     mutable std::atomic<std::size_t> numberOfCallsToCoolFeature { 0 };
 
+    /**
+     * @brief Returns the last set value or a default value if none exists.
+     * @note Thread-safe. Multiple concurrent calls are safe.
+     * @return The last set string or "<default value>" if no strings were set
+     */
     std::string coolFeature() const
     {
         ++numberOfCallsToCoolFeature;