improved docstrings for FBCSR sample matrix generation

ginkgo-project · Nov 26, 2020 · e3fe272 · e3fe272
1 parent d7dd6bc
commit e3fe272
Showing 1 changed file with 10 additions and 9 deletions.
diff --git a/core/test/matrix/fbcsr_sample.hpp b/core/test/matrix/fbcsr_sample.hpp
@@ -113,12 +113,20 @@ class FbcsrSample {
      */
     MatData generate_matrix_data_with_explicit_zeros() const;
 
-    /// Returns an array containing number of stored values in each row
-    ///  (not block-row)
+    /**
+     *  @return An array containing number of stored values in each row
+     */
     gko::Array<index_type> getNonzerosPerRow() const;
 
+    /**
+     * @return FBCSR matrix with absolute values of respective entries
+     */
     std::unique_ptr<Fbcsr> generate_abs_fbcsr() const;
 
+    /**
+     * @return FBCSR matrix with real scalar type,
+     *         with absolute values of respective entries
+     */
     std::unique_ptr<gko::matrix::Fbcsr<remove_complex<value_type>, index_type>>
     generate_abs_fbcsr_abstype() const;
 
@@ -180,15 +188,8 @@ class FbcsrSample2 {
 
     gko::Array<index_type> getNonzerosPerRow() const;
 
-    /**
-     * @return FBCSR matrix with absolute values of respective entries
-     */
     std::unique_ptr<Fbcsr> generate_abs_fbcsr() const;
 
-    /**
-     * @return FBCSR matrix with real scalar type,
-     *         with absolute values of respective entries
-     */
     std::unique_ptr<gko::matrix::Fbcsr<remove_complex<value_type>, index_type>>
     generate_abs_fbcsr_abstype() const;