From: Daniel Arndt Date: Sun, 28 Apr 2019 18:20:33 +0000 (-0400) Subject: Improve doxygen documentation For ReadWriteVector X-Git-Tag: v9.1.0-rc1~165^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7977%2Fhead;p=dealii.git Improve doxygen documentation For ReadWriteVector --- diff --git a/include/deal.II/lac/la_parallel_vector.h b/include/deal.II/lac/la_parallel_vector.h index 8b7cbb9119..f2962990b3 100644 --- a/include/deal.II/lac/la_parallel_vector.h +++ b/include/deal.II/lac/la_parallel_vector.h @@ -43,13 +43,10 @@ namespace LinearAlgebra template class BlockVector; } -} // namespace LinearAlgebra -namespace LinearAlgebra -{ template class ReadWriteVector; -} +} // namespace LinearAlgebra #ifdef DEAL_II_WITH_PETSC namespace PETScWrappers diff --git a/include/deal.II/lac/read_write_vector.h b/include/deal.II/lac/read_write_vector.h index f752ff815a..ba91108853 100644 --- a/include/deal.II/lac/read_write_vector.h +++ b/include/deal.II/lac/read_write_vector.h @@ -107,7 +107,7 @@ namespace LinearAlgebra * *

Storing elements

Most of the time, one will simply read from or * write into a vector of the current class using the global numbers of - * these degrees of freedom. This is done using operator() or operator[] + * these degrees of freedom. This is done using operator()() or operator[]() * which call global_to_local() to transform the global index into a * local one. In such cases, it is clear that one can only access * elements of the vector that the current object indeed stores. @@ -120,7 +120,7 @@ namespace LinearAlgebra * function. To this end, it is necessary to know in which order the * current class stores its element. The elements of all the consecutive * ranges are stored in ascending order of the first index of each range. - * The function largest_range_starting_index() of IndexSet can be used to + * The function IndexSet::largest_range_starting_index() can be used to * get the first index of the largest range. * * @author Bruno Turcksin, 2015.