DOC: Document constructors and assignment operators of Array2D

Anticipating adding one more constructor.
InsightSoftwareConsortium · Mar 7, 2024 · 88e4f10 · 88e4f10
1 parent 091a270
commit 88e4f10
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/Modules/Core/Common/include/itkArray2D.h b/Modules/Core/Common/include/itkArray2D.h
@@ -47,14 +47,23 @@ class ITK_TEMPLATE_EXPORT Array2D : public vnl_matrix<TValue>
   using Self = Array2D;
   using VnlMatrixType = vnl_matrix<TValue>;
 
+  /** Default-constructor. Creates a matrix of size zero (0 rows and 0 columns). */
   Array2D() = default;
+
+  /** Constructs a matrix of the specified number of rows and columns. */
   Array2D(unsigned int numberOfRows, unsigned int numberOfCols);
+
+  /** Copy-constructor. */
   Array2D(const Self & array);
+
+  /** Converting constructor. Implicitly converts the specified matrix to an Array2D. */
   Array2D(const VnlMatrixType & matrix);
 
+  /** Copy-assignment operator. */
   Self &
   operator=(const Self & array);
 
+  /** Assigns the specified matrix to an Array2D. */
   Self &
   operator=(const VnlMatrixType & matrix);