Add some more missing doc

james-d-mitchell · Dec 9, 2024 · f3c38cc · f3c38cc
1 parent 0dea342
commit f3c38cc
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/include/libsemigroups/runner.hpp b/include/libsemigroups/runner.hpp
@@ -547,7 +547,12 @@ namespace libsemigroups {
     // Not noexcept because finished_impl isn't
     [[nodiscard]] bool finished() const;
 
-    // TODO(0) doc
+    //! \brief Check if run has been run to completion successfully.
+    //!
+    //! Returns \c true if \ref run has been run to completion and it was
+    //! successful. The default implementation is to just call \ref finished.
+    //!
+    //! \returns A \c bool.
     [[nodiscard]] virtual bool success() const {
       return finished();
     }