discretization: fix Doxygen documentation

andrea-iob · andrea-iob · commit 337d43ad12e5 · 2022-05-11T13:20:23.000+02:00
diff --git a/src/discretization/stencil_solver.tpp b/src/discretization/stencil_solver.tpp
@@ -849,7 +849,7 @@ void DiscretizationStencilSolver<stencil_t>::assembly(const DiscretizationStenci
 }
 
 /*!
-* Initialize the stencil solver.
+* Assembly the stencil solver.
 *
 * \param partitioned controls if the matrix is partitioned
 * \param communicator is the MPI communicator
@@ -862,7 +862,7 @@ void DiscretizationStencilSolver<stencil_t>::assembly(MPI_Comm communicator, boo
 }
 #else
 /*!
-* Initialize the stencil solver.
+* Assembly the stencil solver.
 *
 * \param assembler is the solver assembler
 */
@@ -886,7 +886,7 @@ void DiscretizationStencilSolver<stencil_t>::assembly(const StencilSolverAssembl
 }
 
 /*!
-* Initialize the stencil solver.
+* Assembly the stencil solver.
 *
 * \param partitioned controls if the matrix is partitioned
 * \param communicator is the MPI communicator
@@ -896,7 +896,7 @@ template<typename stencil_t>
 void DiscretizationStencilSolver<stencil_t>::assembly(MPI_Comm communicator, bool partitioned, const StencilSolverAssembler &assembler)
 #else
 /*!
-* Initialize the stencil solver.
+* Assembly the stencil solver.
 *
 * \param assembler is the solver assembler
 */

Original file line number	Diff line number	Diff line change
`@@ -849,7 +849,7 @@ void DiscretizationStencilSolver<stencil_t>::assembly(const DiscretizationStenci`
`849`	`849`	`}`
`850`	`850`
`851`	`851`	`/*!`
`852`		`-* Initialize the stencil solver.`
	`852`	`+* Assembly the stencil solver.`
`853`	`853`	`*`
`854`	`854`	`* \param partitioned controls if the matrix is partitioned`
`855`	`855`	`* \param communicator is the MPI communicator`
`@@ -862,7 +862,7 @@ void DiscretizationStencilSolver<stencil_t>::assembly(MPI_Comm communicator, boo`
`862`	`862`	`}`
`863`	`863`	`#else`
`864`	`864`	`/*!`
`865`		`-* Initialize the stencil solver.`
	`865`	`+* Assembly the stencil solver.`
`866`	`866`	`*`
`867`	`867`	`* \param assembler is the solver assembler`
`868`	`868`	`*/`
`@@ -886,7 +886,7 @@ void DiscretizationStencilSolver<stencil_t>::assembly(const StencilSolverAssembl`
`886`	`886`	`}`
`887`	`887`
`888`	`888`	`/*!`
`889`		`-* Initialize the stencil solver.`
	`889`	`+* Assembly the stencil solver.`
`890`	`890`	`*`
`891`	`891`	`* \param partitioned controls if the matrix is partitioned`
`892`	`892`	`* \param communicator is the MPI communicator`
`@@ -896,7 +896,7 @@ template<typename stencil_t>`
`896`	`896`	`void DiscretizationStencilSolver<stencil_t>::assembly(MPI_Comm communicator, bool partitioned, const StencilSolverAssembler &assembler)`
`897`	`897`	`#else`
`898`	`898`	`/*!`
`899`		`-* Initialize the stencil solver.`
	`899`	`+* Assembly the stencil solver.`
`900`	`900`	`*`
`901`	`901`	`* \param assembler is the solver assembler`
`902`	`902`	`*/`