From bc5a395ebe29486e9173fdead2d4a72e7b021d05 Mon Sep 17 00:00:00 2001
From: Lucas CHOLLET <lucas.chollet@free.fr>
Date: Sun, 10 Oct 2021 23:23:40 +0100
Subject: [PATCH] Add a description to the vector class

---
 include/cotila/vector/vector.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/cotila/vector/vector.h b/include/cotila/vector/vector.h
index 3c62277..4dca372 100644
--- 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;