Add a description to the vector class

calebzulawski · Oct 10, 2021 · bc5a395 · bc5a395
1 parent d0fca30
commit bc5a395
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/include/cotila/vector/vector.h b/include/cotila/vector/vector.h
@@ -19,6 +19,13 @@ struct matrix;
 template <typename T, std::size_t N, typename Container>
 constexpr matrix<T, N, 1> from_initializer(Container &);
 
+/** @brief A container representing a vector
+ *  @tparam T scalar type to contain
+ *  @tparam N number of rows
+ *
+ *  `cotila::vector` is a container representing a vector.
+ *  It inherits all its properties from `̀cotila::matrix`.
+ */
 template <typename T, std::size_t N>
 struct vector : public matrix<T, N, 1> {
   constexpr vector() = default;