[docs] Fixing typos

tdegeus · Sep 5, 2022 · 0d5b208 · 0d5b208
1 parent 7fc3a79
commit 0d5b208
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 11 deletions.
diff --git a/include/GooseFEM/MatrixDiagonal.h b/include/GooseFEM/MatrixDiagonal.h
@@ -189,7 +189,7 @@ class MatrixDiagonal : public MatrixBase<MatrixDiagonal>,
 
     /**
     Copy as diagonal matrix.
-    \param [#ndof].
+    \return [#ndof].
     */
     [[deprecated]] const array_type::tensor<double, 1>& Todiagonal() const
     {
@@ -198,7 +198,7 @@ class MatrixDiagonal : public MatrixBase<MatrixDiagonal>,
 
     /**
     Underlying matrix
-    \param [#ndof].
+    \return [#ndof].
     */
     const array_type::tensor<double, 1>& data() const
     {

diff --git a/include/GooseFEM/MatrixDiagonalPartitioned.h b/include/GooseFEM/MatrixDiagonalPartitioned.h
@@ -136,7 +136,7 @@ class MatrixDiagonalPartitioned : public MatrixPartitionedBase<MatrixDiagonalPar
 
     /**
     Assemble to diagonal matrix (involves copies).
-    \param [#ndof].
+    \return [#ndof].
     */
     array_type::tensor<double, 1> data() const
     {
@@ -157,7 +157,7 @@ class MatrixDiagonalPartitioned : public MatrixPartitionedBase<MatrixDiagonalPar
 
     /**
     Pointer to data.
-    \param [#nnu].
+    \return [#nnu].
     */
     const array_type::tensor<double, 1>& data_uu() const
     {
@@ -166,7 +166,7 @@ class MatrixDiagonalPartitioned : public MatrixPartitionedBase<MatrixDiagonalPar
 
     /**
     Pointer to data.
-    \param [#nnu].
+    \return [#nnu].
     */
     const array_type::tensor<double, 1>& data_pp() const
     {
@@ -175,7 +175,7 @@ class MatrixDiagonalPartitioned : public MatrixPartitionedBase<MatrixDiagonalPar
 
     /**
     Pointer to data.
-    \param [#nnu].
+    \return [#nnu].
     */
     [[deprecated]] array_type::tensor<double, 1> Todiagonal() const
     {

diff --git a/include/GooseFEM/MeshQuad4.h b/include/GooseFEM/MeshQuad4.h
@@ -223,7 +223,6 @@ class FineLayer : public RegularBase2d<FineLayer> {
     \tparam E e.g. `array_type::tensor<size_t, 2>`
     \param coor Nodal coordinates ``[nnode, ndim]`` with ``ndim == 2``.
     \param conn Connectivity ``[nne, nne]`` with ``nne == 4``.
-    \throw GOOSEFEM_CHECK()
     */
     template <class C, class E, std::enable_if_t<xt::is_xexpression<C>::value, bool> = true>
     FineLayer(const C& coor, const E& conn)

diff --git a/include/GooseFEM/TyingsPeriodic.h b/include/GooseFEM/TyingsPeriodic.h
@@ -390,7 +390,7 @@ class Control {
     /**
     Nodal coordinates, for the system with control nodes added to it.
 
-    \param [nnode + ndim, ndim], with nnode the number of nodes of the original system.
+    \return [nnode + ndim, ndim], with nnode the number of nodes of the original system.
     */
     const array_type::tensor<double, 2>& coor() const
     {
@@ -400,7 +400,7 @@ class Control {
     /**
     DOF-numbers per node, for the system with control nodes added to it.
 
-    \param [nnode + ndim, ndim], with nnode the number of nodes of the original system.
+    \return [nnode + ndim, ndim], with nnode the number of nodes of the original system.
     */
     const array_type::tensor<size_t, 2>& dofs() const
     {
@@ -410,7 +410,7 @@ class Control {
     /**
     DOF-numbers of each control node.
 
-    \param [ndim, ndim].
+    \return [ndim, ndim].
     */
     const array_type::tensor<size_t, 2>& controlDofs() const
     {
@@ -420,7 +420,7 @@ class Control {
     /**
     Node-numbers of the control nodes.
 
-    \param [ndim].
+    \return [ndim].
     */
     const array_type::tensor<size_t, 1>& controlNodes() const
     {