From: wolf Date: Tue, 23 Mar 2004 20:49:43 +0000 (+0000) Subject: Doc update. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d3e69c3d03abc11776e928f6f2e9f34ec24fc37;p=dealii-svn.git Doc update. git-svn-id: https://svn.dealii.org/trunk@8856 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/petsc_matrix_base.h b/deal.II/lac/include/lac/petsc_matrix_base.h index 52a92d90c5..7f86ae4b33 100644 --- a/deal.II/lac/include/lac/petsc_matrix_base.h +++ b/deal.II/lac/include/lac/petsc_matrix_base.h @@ -299,7 +299,7 @@ namespace PETScWrappers /** * Set the element (i,j) - * to value. Throws an + * to @arg value. Throws an * error if the entry does not * exist. Still, it is allowed to * store zero values in @@ -310,7 +310,7 @@ namespace PETScWrappers const PetscScalar value); /** - * Add value to the + * Add @arg value to the * element (i,j). Throws * an error if the entry does not * exist. Still, it is allowed to @@ -560,7 +560,7 @@ namespace PETScWrappers * the residual is defined to be * r=b-Mx. Write the * residual into - * dst. The + * @arg dst. The * l2 norm of * the residual vector is * returned. @@ -586,13 +586,13 @@ namespace PETScWrappers /** * STL-like iterator with the - * first entry of row r. + * first entry of row @arg r. */ const_iterator begin (const unsigned int r) const; /** * Final iterator of row - * r. + * @arg r. */ const_iterator end (const unsigned int r) const; diff --git a/deal.II/lac/include/lac/petsc_sparse_matrix.h b/deal.II/lac/include/lac/petsc_sparse_matrix.h index bdfeb53421..ff7beb0e49 100644 --- a/deal.II/lac/include/lac/petsc_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_sparse_matrix.h @@ -48,9 +48,9 @@ namespace PETScWrappers /** * Create a sparse matrix of dimensions - * m times n, with an + * @arg m times @arg n, with an * initial guess of - * n_nonzero_per_row nonzero + * @arg n_nonzero_per_row nonzero * elements per row. PETSc is able to * cope with the situation that more * than this number of elements is @@ -76,11 +76,11 @@ namespace PETScWrappers /** * Initialize a rectangular matrix with - * m rows and n + * @arg m rows and @arg n * columns. The maximal number of * nonzero entries for each row * separately is given by the - * row_lengths array. + * @arg row_lengths array. * * Just as for the other constructors: * PETSc is able to cope with the