]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Replace @see by the more correct command @ref
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 5 Jun 2002 12:23:13 +0000 (12:23 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 5 Jun 2002 12:23:13 +0000 (12:23 +0000)
git-svn-id: https://svn.dealii.org/trunk@5998 0785d39b-7218-0410-832d-ea1e28bc413d

17 files changed:
deal.II/base/include/base/exceptions.h
deal.II/base/include/base/parameter_handler.h
deal.II/deal.II/include/dofs/dof_accessor.h
deal.II/deal.II/include/dofs/dof_handler.h
deal.II/deal.II/include/fe/fe.h
deal.II/deal.II/include/fe/fe_values.h
deal.II/deal.II/include/grid/persistent_tria.h
deal.II/deal.II/include/grid/tria.h
deal.II/deal.II/include/grid/tria_iterator.h
deal.II/deal.II/include/grid/tria_levels.h
deal.II/deal.II/include/multigrid/mg_dof_accessor.h
deal.II/deal.II/include/multigrid/mg_dof_handler.h
deal.II/deal.II/include/multigrid/mg_dof_tools.h
deal.II/deal.II/include/numerics/time_dependent.h
deal.II/lac/include/lac/block_matrix_array.h
deal.II/lac/include/lac/full_matrix.h
deal.II/lac/include/lac/precondition_block.h

index a41879ef074ef12fa6120885ea320d08ca54206f..59ef78c0f1510708207153e76149d4ff6fc31078 100644 (file)
@@ -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 <class exc>
     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 <class exc>
     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 {                             \
index fc255262e79cd067ea3e2f3c557da9d59fb79984..6e7fa43907fb2a9c80912a63c22b5c0ee3e396c4 100644 (file)
@@ -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
 {
index 0e5e9a899033a61c2c94c3291d32a322718ae9a1..b405301814a677ac293ac44858e9082a3c6ae788 100644 (file)
@@ -668,7 +668,7 @@ class DoFObjectAccessor<1, dim> :  public DoFAccessor<dim>,
 /**
  * Grant access to the degrees of freedom located on quads.
  *
- * @see DoFObjectAccessor
+ * @ref DoFObjectAccessor
  */
 template <int dim>
 class DoFObjectAccessor<2, dim> :  public DoFAccessor<dim>,
@@ -865,7 +865,7 @@ class DoFObjectAccessor<2, dim> :  public DoFAccessor<dim>,
 /**
  * Grant access to the degrees of freedom located on hexes.
  *
- * @see DoFObjectAccessor
+ * @ref DoFObjectAccessor
  */
 template <int dim>
 class DoFObjectAccessor<3, dim> :  public DoFAccessor<dim>,
index 9c6f0a97e87751064cdb6b514312996ae88d7267..c3fbe4bfd6af600ac32f50215363a364a6426916 100644 (file)
@@ -41,8 +41,8 @@ template <int dim> 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
  */
index 5957eae5810311bb3bce6da07eb962600d7403fd..6b67093942d2efd051e9e167459d01076f9b7f5d 100644 (file)
@@ -154,14 +154,14 @@ class FiniteElement : public FiniteElementBase<dim>
                                     /**
                                      * 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;
   
index d702d5f092a8de2f3ab96545958a81901d9f7864..1f29f44e28b2674973bb675a0fc22927e83c7f0c 100644 (file)
@@ -731,7 +731,7 @@ class FEValues : public FEValuesBase<dim>
  * 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
  */
index ed5494c5ed5dd992b8e498b3517c22f5cf03ae65..95b62111fb047526a735a3398aa169bdcd525677 100644 (file)
@@ -277,7 +277,7 @@ class PersistentTriangulation : public Triangulation<dim>
     std::vector<std::vector<bool> >   refine_flags;
 
                                     /**
-                                     * @see refine_flags
+                                     * @ref refine_flags
                                      */
     std::vector<std::vector<bool> >   coarsen_flags;
 };
index 9bc9d22e113c087de1a70d5a2e0cfaa9e49118fe..77542fbfa000944eab32ce6ddf7ae0420d15573c 100644 (file)
@@ -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 <int dim>
index 0bbb7ddc58962a51900cf700b05c69921053e06e..c3d1724f0d7683313462f2461208cf211967ddcb 100644 (file)
@@ -224,10 +224,10 @@ template <int dim> 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 <int dim, typename Accessor>
index 4caa716d3ec37d7bb3207eaf2bedbb64469f4a20..0a446a800787217be98ae59ae888b3b8882d5aa0 100644 (file)
@@ -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 <int dim>
 class TriangulationLevel
index ca3bd81946217eda06be5c0f2aed8084a414d2bb..81bf9735d68e210d58e3fb46d1f25a036426620f 100644 (file)
@@ -341,7 +341,7 @@ class MGDoFObjectAccessor<1, dim> :  public MGDoFAccessor<dim>,
 /**
  * Grant access to the multilevel degrees of freedom located on quads.
  *
- * @see DoFLineAccessor
+ * @ref DoFLineAccessor
  */
 template <int dim>
 class MGDoFObjectAccessor<2, dim> :  public MGDoFAccessor<dim>,
@@ -466,7 +466,7 @@ class MGDoFObjectAccessor<2, dim> :  public MGDoFAccessor<dim>,
 /**
  * Grant access to the multilevel degrees of freedom located on hexhedra.
  *
- * @see DoFLineAccessor
+ * @ref DoFLineAccessor
  */
 template <int dim>
 class MGDoFObjectAccessor<3, dim> :  public MGDoFAccessor<dim>,
index 3e09a4ebfd124f48ce2fdab83e2d9d68679d0ddf..ec85d453de1e12b2bbcc19c5ad000ee34e12e387 100644 (file)
@@ -31,8 +31,8 @@ template <int dim>              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 <int dim>
 class MGDoFDimensionInfo
index d26a39fd05d44611b2d770f664ea73c2e02927d4..a7d2233fb494972485fa04f677f2959f07bd1966 100644 (file)
@@ -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 <int dim, class SparsityPattern>
@@ -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 <int dim, class SparsityPattern>
     static void
index 274f05db54989059336152144e07efbddfd1ef1e..4930e1cc42ce7b1a20ce3ec4806d7db6556a9f9e 100644 (file)
@@ -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<std::vector<bool> >   refine_flags;
 
                                     /**
-                                     * @see refine_flags
+                                     * @ref refine_flags
                                      */
     std::vector<std::vector<bool> >   coarsen_flags;
 
index 49d0551ee481826971ba3fc9bc8554ac66d050ec..3c06b233149ee2e2fadaebfa8e13f4ccce43e1ae 100644 (file)
@@ -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.
  *
index 01b33d8eb0c46f0c11e58f91c7e2535fc6ed45d6..4f812042a52947607e2e9d6c245fffb8a504d5d8 100644 (file)
@@ -593,7 +593,7 @@ class FullMatrix : public vector2d<number>
                                      * Backward elimination of upper
                                      * triangle.
                                      *
-                                     * @see forward
+                                     * @ref forward
                                      */
     template<typename number2>
     void backward (Vector<number2>       &dst,
index 47ef10647021fea58494fed24cfee212367def4a..475a6b1a7dbab2d5a9200620d0b83bbceb7d065c 100644 (file)
@@ -281,7 +281,7 @@ class PreconditionBlock : public virtual Subscriptor
                                      
                                     /**
                                      * Flag for diagonal compression.
-                                     * @see set_same_diagonal()
+                                     * @ref set_same_diagonal()
                                      */
     bool same_diagonal;
 };

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.