From 8ffea24c13c5fb049605c04055cece82f60fd462 Mon Sep 17 00:00:00 2001 From: wolf Date: Wed, 5 Jun 2002 12:23:13 +0000 Subject: [PATCH] Replace @see by the more correct command @ref git-svn-id: https://svn.dealii.org/trunk@5998 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/exceptions.h | 22 +++++++++---------- deal.II/base/include/base/parameter_handler.h | 4 ++-- deal.II/deal.II/include/dofs/dof_accessor.h | 4 ++-- deal.II/deal.II/include/dofs/dof_handler.h | 4 ++-- deal.II/deal.II/include/fe/fe.h | 4 ++-- deal.II/deal.II/include/fe/fe_values.h | 2 +- .../deal.II/include/grid/persistent_tria.h | 2 +- deal.II/deal.II/include/grid/tria.h | 2 +- deal.II/deal.II/include/grid/tria_iterator.h | 8 +++---- deal.II/deal.II/include/grid/tria_levels.h | 4 ++-- .../include/multigrid/mg_dof_accessor.h | 4 ++-- .../include/multigrid/mg_dof_handler.h | 4 ++-- .../deal.II/include/multigrid/mg_dof_tools.h | 6 ++--- .../deal.II/include/numerics/time_dependent.h | 4 ++-- deal.II/lac/include/lac/block_matrix_array.h | 2 +- deal.II/lac/include/lac/full_matrix.h | 2 +- deal.II/lac/include/lac/precondition_block.h | 2 +- 17 files changed, 40 insertions(+), 40 deletions(-) diff --git a/deal.II/base/include/base/exceptions.h b/deal.II/base/include/base/exceptions.h index a41879ef07..59ef78c0f1 100644 --- a/deal.II/base/include/base/exceptions.h +++ b/deal.II/base/include/base/exceptions.h @@ -465,7 +465,7 @@ namespace deal_II_exceptions * exception generation mechanism used in the * @p{Assert} macro. * - * @see ExceptionBase + * @ref ExceptionBase */ void issue_error_assert (const char *file, int line, @@ -480,7 +480,7 @@ namespace deal_II_exceptions * exception generation mechanism used in the * @p{AssertThrow} macro. * - * @see ExceptionBase + * @ref ExceptionBase */ template void issue_error_throw (const char *file, @@ -505,7 +505,7 @@ namespace deal_II_exceptions * difficulties in connection with the way we use the macro and the * declaration of the exception classes. * - * @see ExceptionBase + * @ref ExceptionBase */ template inline @@ -544,7 +544,7 @@ namespace deal_II_exceptions * * See the @p{ExceptionBase} class for more information. * - * @see ExceptionBase + * @ref ExceptionBase * @author Wolfgang Bangerth, November 1997, extensions 1998 */ #define Assert(cond, exc) \ @@ -582,7 +582,7 @@ namespace deal_II_exceptions * * See the @p{ExceptionBase} class for more information. * - * @see ExceptionBase + * @ref ExceptionBase * @author Wolfgang Bangerth, November 1997, extensions 1998 */ #ifndef DISABLE_ASSERT_THROW @@ -619,7 +619,7 @@ namespace deal_II_exceptions /** * See the @p{ExceptionBase} class for a detailed description. * - * @see ExceptionBase + * @ref ExceptionBase * @author Wolfgang Bangerth, November 1997 */ #define DeclException0(Exception0) \ @@ -631,7 +631,7 @@ class Exception0 : public ExceptionBase {} * Declare an exception class with * one additional parameter. * - * @see ExceptionBase + * @ref ExceptionBase */ #define DeclException1(Exception1, type1, outsequence) \ class Exception1 : public ExceptionBase { \ @@ -651,7 +651,7 @@ class Exception1 : public ExceptionBase { \ * Declare an exception class with * two additional parameters. * - * @see ExceptionBase + * @ref ExceptionBase */ #define DeclException2(Exception2, type1, type2, outsequence) \ class Exception2 : public ExceptionBase { \ @@ -673,7 +673,7 @@ class Exception2 : public ExceptionBase { \ * Declare an exception class with * three additional parameters. * - * @see ExceptionBase + * @ref ExceptionBase */ #define DeclException3(Exception3, type1, type2, type3, outsequence) \ class Exception3 : public ExceptionBase { \ @@ -696,7 +696,7 @@ class Exception3 : public ExceptionBase { \ * Declare an exception class with * four additional parameters. * - * @see ExceptionBase + * @ref ExceptionBase */ #define DeclException4(Exception4, type1, type2, type3, type4, outsequence) \ class Exception4 : public ExceptionBase { \ @@ -721,7 +721,7 @@ class Exception4 : public ExceptionBase { \ * Declare an exception class with * five additional parameters. * - * @see ExceptionBase + * @ref ExceptionBase */ #define DeclException5(Exception5, type1, type2, type3, type4, type5, outsequence) \ class Exception5 : public ExceptionBase { \ diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index fc255262e7..6e7fa43907 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -1054,7 +1054,7 @@ namespace Patterns * This class is inspired by the @p{MenuSystem} class of @p{DiffPack}. * * @author Wolfgang Bangerth, October 1997, revised February 1998 - * @see MultipleParameterLoop + * @ref MultipleParameterLoop */ class ParameterHandler { @@ -1615,7 +1615,7 @@ class ParameterHandler * * @author Wolfgang Bangerth, October 1997 * @version 1.0 - * @see ParameterHandler + * @ref ParameterHandler */ class MultipleParameterLoop : public ParameterHandler { diff --git a/deal.II/deal.II/include/dofs/dof_accessor.h b/deal.II/deal.II/include/dofs/dof_accessor.h index 0e5e9a8990..b405301814 100644 --- a/deal.II/deal.II/include/dofs/dof_accessor.h +++ b/deal.II/deal.II/include/dofs/dof_accessor.h @@ -668,7 +668,7 @@ class DoFObjectAccessor<1, dim> : public DoFAccessor, /** * Grant access to the degrees of freedom located on quads. * - * @see DoFObjectAccessor + * @ref DoFObjectAccessor */ template class DoFObjectAccessor<2, dim> : public DoFAccessor, @@ -865,7 +865,7 @@ class DoFObjectAccessor<2, dim> : public DoFAccessor, /** * Grant access to the degrees of freedom located on hexes. * - * @see DoFObjectAccessor + * @ref DoFObjectAccessor */ template class DoFObjectAccessor<3, dim> : public DoFAccessor, diff --git a/deal.II/deal.II/include/dofs/dof_handler.h b/deal.II/deal.II/include/dofs/dof_handler.h index 9c6f0a97e8..c3fbe4bfd6 100644 --- a/deal.II/deal.II/include/dofs/dof_handler.h +++ b/deal.II/deal.II/include/dofs/dof_handler.h @@ -41,8 +41,8 @@ template class Triangulation; * Define some types which differ between the dimensions. This class * is analogous to the @ref{TriaDimensionInfo} class hierarchy. * - * @see DoFDimensionInfo<1> - * @see DoFDimensionInfo<2> + * @ref DoFDimensionInfo<1> + * @ref DoFDimensionInfo<2> * * @author Wolfgang Bangerth, 1998 */ diff --git a/deal.II/deal.II/include/fe/fe.h b/deal.II/deal.II/include/fe/fe.h index 5957eae581..6b67093942 100644 --- a/deal.II/deal.II/include/fe/fe.h +++ b/deal.II/deal.II/include/fe/fe.h @@ -154,14 +154,14 @@ class FiniteElement : public FiniteElementBase /** * Compute flags for initial * update only. - * @see{FEValuesBase} + * @ref{FEValuesBase} */ virtual UpdateFlags update_once (const UpdateFlags flags) const = 0; /** * Compute flags for update on * each cell. - * @see{FEValuesBase} + * @ref{FEValuesBase} */ virtual UpdateFlags update_each (const UpdateFlags flags) const = 0; diff --git a/deal.II/deal.II/include/fe/fe_values.h b/deal.II/deal.II/include/fe/fe_values.h index d702d5f092..1f29f44e28 100644 --- a/deal.II/deal.II/include/fe/fe_values.h +++ b/deal.II/deal.II/include/fe/fe_values.h @@ -731,7 +731,7 @@ class FEValues : public FEValuesBase * interface to access those. Implementations are in derived classes * @p{FEFaceValues} and @p{FESubfaceValues}. * - * @see{FEValuesBase} + * @ref{FEValuesBase} * * @author Wolfgang Bangerth, 1998, Guido Kanschat, 2000, 2001 */ diff --git a/deal.II/deal.II/include/grid/persistent_tria.h b/deal.II/deal.II/include/grid/persistent_tria.h index ed5494c5ed..95b62111fb 100644 --- a/deal.II/deal.II/include/grid/persistent_tria.h +++ b/deal.II/deal.II/include/grid/persistent_tria.h @@ -277,7 +277,7 @@ class PersistentTriangulation : public Triangulation std::vector > refine_flags; /** - * @see refine_flags + * @ref refine_flags */ std::vector > coarsen_flags; }; diff --git a/deal.II/deal.II/include/grid/tria.h b/deal.II/deal.II/include/grid/tria.h index 9bc9d22e11..77542fbfa0 100644 --- a/deal.II/deal.II/include/grid/tria.h +++ b/deal.II/deal.II/include/grid/tria.h @@ -1588,7 +1588,7 @@ struct TriaNumberCache<3> : public TriaNumberCache<2> * object, you should be well aware that you might involuntarily alter the * data stored in the triangulation. * - * @see TriaRawIterator + * @ref TriaRawIterator * @author Wolfgang Bangerth, 1998 */ template diff --git a/deal.II/deal.II/include/grid/tria_iterator.h b/deal.II/deal.II/include/grid/tria_iterator.h index 0bbb7ddc58..c3d1724f0d 100644 --- a/deal.II/deal.II/include/grid/tria_iterator.h +++ b/deal.II/deal.II/include/grid/tria_iterator.h @@ -224,10 +224,10 @@ template class Triangulation; * to the disallowed state "invalid" which increases the chance that somehwen * earlier than for past-the-end iterators an exception is raised. * - * @see Triangulation - * @see TriaDimensionInfo<1> - * @see TriaDimensionInfo<2> - * @see TriaDimensionInfo<3> + * @ref Triangulation + * @ref TriaDimensionInfo<1> + * @ref TriaDimensionInfo<2> + * @ref TriaDimensionInfo<3> * @author Wolfgang Bangerth, 1998 */ template diff --git a/deal.II/deal.II/include/grid/tria_levels.h b/deal.II/deal.II/include/grid/tria_levels.h index 4caa716d3e..0a446a8007 100644 --- a/deal.II/deal.II/include/grid/tria_levels.h +++ b/deal.II/deal.II/include/grid/tria_levels.h @@ -27,8 +27,8 @@ * hierarchy of a triangulation. This template is only declared to allow * specializations for different dimensions. * - * @see TriangulationLevel<1> - * @see TriangulationLevel<2> + * @ref TriangulationLevel<1> + * @ref TriangulationLevel<2> */ template class TriangulationLevel diff --git a/deal.II/deal.II/include/multigrid/mg_dof_accessor.h b/deal.II/deal.II/include/multigrid/mg_dof_accessor.h index ca3bd81946..81bf9735d6 100644 --- a/deal.II/deal.II/include/multigrid/mg_dof_accessor.h +++ b/deal.II/deal.II/include/multigrid/mg_dof_accessor.h @@ -341,7 +341,7 @@ class MGDoFObjectAccessor<1, dim> : public MGDoFAccessor, /** * Grant access to the multilevel degrees of freedom located on quads. * - * @see DoFLineAccessor + * @ref DoFLineAccessor */ template class MGDoFObjectAccessor<2, dim> : public MGDoFAccessor, @@ -466,7 +466,7 @@ class MGDoFObjectAccessor<2, dim> : public MGDoFAccessor, /** * Grant access to the multilevel degrees of freedom located on hexhedra. * - * @see DoFLineAccessor + * @ref DoFLineAccessor */ template class MGDoFObjectAccessor<3, dim> : public MGDoFAccessor, diff --git a/deal.II/deal.II/include/multigrid/mg_dof_handler.h b/deal.II/deal.II/include/multigrid/mg_dof_handler.h index 3e09a4ebfd..ec85d453de 100644 --- a/deal.II/deal.II/include/multigrid/mg_dof_handler.h +++ b/deal.II/deal.II/include/multigrid/mg_dof_handler.h @@ -31,8 +31,8 @@ template class MGDoFObjectAccessor<3, dim>; * Define some types which differ between the dimensions. This class * is analogous to the @ref{TriaDimensionInfo} class hierarchy. * - * @see MGDoFDimensionInfo<1> - * @see MGDoFDimensionInfo<2> + * @ref MGDoFDimensionInfo<1> + * @ref MGDoFDimensionInfo<2> */ template class MGDoFDimensionInfo diff --git a/deal.II/deal.II/include/multigrid/mg_dof_tools.h b/deal.II/deal.II/include/multigrid/mg_dof_tools.h index d26a39fd05..a7d2233fb4 100644 --- a/deal.II/deal.II/include/multigrid/mg_dof_tools.h +++ b/deal.II/deal.II/include/multigrid/mg_dof_tools.h @@ -61,7 +61,7 @@ class MGTools /** * Make a sparsity pattern including fluxes * of discontinuous Galerkin methods. - * @see make_sparsity_pattern + * @ref make_sparsity_pattern * $see DoFTools */ template @@ -74,8 +74,8 @@ class MGTools * Create sparsity pattern for * the fluxes at refinement * edges. - * @see{make_flux_sparsity_pattern} - * @see{DoFTools} + * @ref{make_flux_sparsity_pattern} + * @ref{DoFTools} */ template static void diff --git a/deal.II/deal.II/include/numerics/time_dependent.h b/deal.II/deal.II/include/numerics/time_dependent.h index 274f05db54..4930e1cc42 100644 --- a/deal.II/deal.II/include/numerics/time_dependent.h +++ b/deal.II/deal.II/include/numerics/time_dependent.h @@ -1431,7 +1431,7 @@ namespace TimeStepBase_Tria_Flags const double cell_number_corridor_top; /** - * @see cell_number_corridor_top + * @ref cell_number_corridor_top */ const double cell_number_corridor_bottom; @@ -1836,7 +1836,7 @@ class TimeStepBase_Tria : public TimeStepBase std::vector > refine_flags; /** - * @see refine_flags + * @ref refine_flags */ std::vector > coarsen_flags; diff --git a/deal.II/lac/include/lac/block_matrix_array.h b/deal.II/lac/include/lac/block_matrix_array.h index 49d0551ee4..3c06b23314 100644 --- a/deal.II/lac/include/lac/block_matrix_array.h +++ b/deal.II/lac/include/lac/block_matrix_array.h @@ -213,7 +213,7 @@ class BlockMatrixArray : public Subscriptor * matrix. Then, forward or backward insertion is performed * block-wise. The diagonal blocks are NOT inverted for this purpose! * - * While block indices may be duplicated (see @see{BlockMatrixArray}) + * While block indices may be duplicated (see @ref{BlockMatrixArray}) * to add blocks, this is not allowed on the diagonal. A short * computation reveals why. * diff --git a/deal.II/lac/include/lac/full_matrix.h b/deal.II/lac/include/lac/full_matrix.h index 01b33d8eb0..4f812042a5 100644 --- a/deal.II/lac/include/lac/full_matrix.h +++ b/deal.II/lac/include/lac/full_matrix.h @@ -593,7 +593,7 @@ class FullMatrix : public vector2d * Backward elimination of upper * triangle. * - * @see forward + * @ref forward */ template void backward (Vector &dst, diff --git a/deal.II/lac/include/lac/precondition_block.h b/deal.II/lac/include/lac/precondition_block.h index 47ef106470..475a6b1a7d 100644 --- a/deal.II/lac/include/lac/precondition_block.h +++ b/deal.II/lac/include/lac/precondition_block.h @@ -281,7 +281,7 @@ class PreconditionBlock : public virtual Subscriptor /** * Flag for diagonal compression. - * @see set_same_diagonal() + * @ref set_same_diagonal() */ bool same_diagonal; }; -- 2.39.5