* exception generation mechanism used in the
* @p{Assert} macro.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
*/
void issue_error_assert (const char *file,
int line,
* exception generation mechanism used in the
* @p{AssertThrow} macro.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
*/
template <class exc>
void issue_error_throw (const char *file,
* 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
*
* See the @p{ExceptionBase} class for more information.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
* @author Wolfgang Bangerth, November 1997, extensions 1998
*/
#define Assert(cond, exc) \
*
* See the @p{ExceptionBase} class for more information.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
* @author Wolfgang Bangerth, November 1997, extensions 1998
*/
#ifndef DISABLE_ASSERT_THROW
/**
* See the @p{ExceptionBase} class for a detailed description.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
* @author Wolfgang Bangerth, November 1997
*/
#define DeclException0(Exception0) \
* Declare an exception class with
* one additional parameter.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
*/
#define DeclException1(Exception1, type1, outsequence) \
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 { \
* Declare an exception class with
* three additional parameters.
*
- * @see ExceptionBase
+ * @ref ExceptionBase
*/
#define DeclException3(Exception3, type1, type2, type3, outsequence) \
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 { \
* 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 { \
* 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
{
*
* @author Wolfgang Bangerth, October 1997
* @version 1.0
- * @see ParameterHandler
+ * @ref ParameterHandler
*/
class MultipleParameterLoop : public ParameterHandler
{
/**
* Grant access to the degrees of freedom located on quads.
*
- * @see DoFObjectAccessor
+ * @ref DoFObjectAccessor
*/
template <int dim>
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>,
* 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
*/
/**
* 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;
* 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
*/
std::vector<std::vector<bool> > refine_flags;
/**
- * @see refine_flags
+ * @ref refine_flags
*/
std::vector<std::vector<bool> > coarsen_flags;
};
* 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>
* 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>
* 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
/**
* 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>,
/**
* 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>,
* 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
/**
* 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>
* 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
const double cell_number_corridor_top;
/**
- * @see cell_number_corridor_top
+ * @ref cell_number_corridor_top
*/
const double cell_number_corridor_bottom;
std::vector<std::vector<bool> > refine_flags;
/**
- * @see refine_flags
+ * @ref refine_flags
*/
std::vector<std::vector<bool> > coarsen_flags;
* 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.
*
* Backward elimination of upper
* triangle.
*
- * @see forward
+ * @ref forward
*/
template<typename number2>
void backward (Vector<number2> &dst,
/**
* Flag for diagonal compression.
- * @see set_same_diagonal()
+ * @ref set_same_diagonal()
*/
bool same_diagonal;
};