]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 23 Mar 2004 20:49:43 +0000 (20:49 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 23 Mar 2004 20:49:43 +0000 (20:49 +0000)
git-svn-id: https://svn.dealii.org/trunk@8856 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/petsc_matrix_base.h
deal.II/lac/include/lac/petsc_sparse_matrix.h

index 52a92d90c55c24ce7378d71e8f7029efc67973e1..7f86ae4b3319ce7803e0c0ece899b46c912846a8 100644 (file)
@@ -299,7 +299,7 @@ namespace PETScWrappers
 
                                        /**
                                         * Set the element (<i>i,j</i>)
-                                        * to <tt>value</tt>. 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 <tt>value</tt> to the
+                                        * Add @arg value to the
                                         * element (<i>i,j</i>).  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
                                         * <i>r=b-Mx</i>. Write the
                                         * residual into
-                                        * <tt>dst</tt>. The
+                                        * @arg dst. The
                                         * <i>l<sub>2</sub></i> norm of
                                         * the residual vector is
                                         * returned.
@@ -586,13 +586,13 @@ namespace PETScWrappers
 
                                        /**
                                         * STL-like iterator with the
-                                        * first entry of row <tt>r</tt>.
+                                        * first entry of row @arg r.
                                         */
       const_iterator begin (const unsigned int r) const;
 
                                        /**
                                         * Final iterator of row
-                                        * <tt>r</tt>.
+                                        * @arg r.
                                         */
       const_iterator end (const unsigned int r) const;
       
index bdfeb53421c4e5db6062aec8859fb3ff372ef152..ff7beb0e49c79fbd7f3c46e48507e1ce50a1bc76 100644 (file)
@@ -48,9 +48,9 @@ namespace PETScWrappers
       
                                        /**
                                         * Create a sparse matrix of dimensions
-                                        * <tt>m</tt> times <tt>n</tt>, with an
+                                        * @arg m times @arg n, with an
                                         * initial guess of
-                                        * <tt>n_nonzero_per_row</tt> 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
-                                        * <tt>m</tt> rows and <tt>n</tt>
+                                        * @arg m rows and @arg n
                                         * columns.  The maximal number of
                                         * nonzero entries for each row
                                         * separately is given by the
-                                        * <tt>row_lengths</tt> array.
+                                        * @arg row_lengths array.
                                         *
                                         * Just as for the other constructors:
                                         * PETSc is able to cope with the

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.