dealii · masterleinad · Aug 18, 2019 · Aug 16, 2019 · Aug 17, 2019
diff --git a/doc/news/changes/minor/20190816RezaRastak b/doc/news/changes/minor/20190816RezaRastak
@@ -0,0 +1,4 @@
+Fixed: Forward declarations in header files are prevented from confusing
+doxygen.
+<br>
+(Reza Rastak, 2019/08/16)
diff --git a/include/deal.II/algorithms/newton.h b/include/deal.II/algorithms/newton.h
@@ -26,7 +26,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 class ParameterHandler;
+#endif
 
 namespace Algorithms
 {

diff --git a/include/deal.II/algorithms/theta_timestepping.h b/include/deal.II/algorithms/theta_timestepping.h
@@ -24,7 +24,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 class ParameterHandler;
+#endif
 
 namespace Algorithms
 {

diff --git a/include/deal.II/algorithms/timestep_control.h b/include/deal.II/algorithms/timestep_control.h
@@ -26,7 +26,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 class ParameterHandler;
+#endif
 
 namespace Algorithms
 {

diff --git a/include/deal.II/base/complex_overloads.h b/include/deal.II/base/complex_overloads.h
@@ -23,10 +23,12 @@
 DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
+#ifndef DOXYGEN
 template <typename T>
 struct EnableIfScalar;
 template <typename T, typename U>
 struct ProductType;
+#endif
 
 #ifndef DEAL_II_HAVE_COMPLEX_OPERATOR_OVERLOADS
 /**

diff --git a/include/deal.II/base/data_out_base.h b/include/deal.II/base/data_out_base.h
@@ -47,9 +47,11 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-
+// Forward declarations
+#ifndef DOXYGEN
 class ParameterHandler;
 class XDMFEntry;
+#endif
 
 /**
  * This is a base class for output of data on meshes of very general form.

diff --git a/include/deal.II/base/function.h b/include/deal.II/base/function.h
@@ -31,11 +31,13 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-
+// Forward declarations
+#ifndef DOXYGEN
 template <typename number>
 class Vector;
 template <int rank, int dim, typename Number>
 class TensorFunction;
+#endif
 
 /**
  * This class is a model for a general function that, given a point at which

diff --git a/include/deal.II/base/function_parser.h b/include/deal.II/base/function_parser.h
@@ -36,10 +36,11 @@ namespace mu
 
 DEAL_II_NAMESPACE_OPEN
 
-
+// Forward declaration
+#ifndef DOXYGEN
 template <typename>
 class Vector;
-
+#endif
 
 /**
  * This class implements a function object that gets its value by parsing a

diff --git a/include/deal.II/base/incremental_function.h b/include/deal.II/base/incremental_function.h
@@ -22,8 +22,11 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 template <typename number>
 class Vector;
+#endif
 
 namespace Functions
 {

diff --git a/include/deal.II/base/iterator_range.h b/include/deal.II/base/iterator_range.h
@@ -27,10 +27,11 @@
 DEAL_II_NAMESPACE_OPEN
 
 
-// Forward declarations
+// Forward declaration
+#ifndef DOXYGEN
 template <typename Iterator>
 class IteratorOverIterators;
-
+#endif
 
 
 /**

diff --git a/include/deal.II/base/mpi.h b/include/deal.II/base/mpi.h
@@ -87,13 +87,15 @@ DEAL_II_NAMESPACE_OPEN
 
 
 // Forward type declarations to allow MPI sums over tensorial types
+#ifndef DOXYGEN
 template <int rank, int dim, typename Number>
 class Tensor;
 template <int rank, int dim, typename Number>
 class SymmetricTensor;
 template <typename Number>
 class SparseMatrix;
 class IndexSet;
+#endif
 
 namespace Utilities
 {

diff --git a/include/deal.II/base/numbers.h b/include/deal.II/base/numbers.h
@@ -126,12 +126,14 @@ namespace internal
 } // namespace internal
 
 // forward declarations to support abs or sqrt operations on VectorizedArray
+#ifndef DOXYGEN
 template <typename Number,
           int width =
             internal::VectorizedArrayWidthSpecifier<Number>::max_width>
 class VectorizedArray;
 template <typename T>
 struct EnableIfScalar;
+#endif
 
 DEAL_II_NAMESPACE_CLOSE
 

diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h
@@ -36,8 +36,10 @@
 DEAL_II_NAMESPACE_OPEN
 
 // forward declarations for interfaces and friendship
+#ifndef DOXYGEN
 class LogStream;
 class MultipleParameterLoop;
+#endif
 
 /**
  * The ParameterHandler class provides a standard interface to an input file

diff --git a/include/deal.II/base/patterns.h b/include/deal.II/base/patterns.h
@@ -54,10 +54,12 @@ DEAL_II_ENABLE_EXTRA_DIAGNOSTICS
 DEAL_II_NAMESPACE_OPEN
 
 // forward declarations for interfaces and friendship
+#ifndef DOXYGEN
 class LogStream;
 class MultipleParameterLoop;
 template <int dim>
 class FunctionParser;
+#endif
 
 /**
  * Namespace for a few classes that act as patterns for the ParameterHandler

diff --git a/include/deal.II/base/process_grid.h b/include/deal.II/base/process_grid.h
@@ -27,9 +27,10 @@ DEAL_II_NAMESPACE_OPEN
 
 
 // Forward declaration of class ScaLAPACKMatrix for ProcessGrid
+#  ifndef DOXYGEN
 template <typename NumberType>
 class ScaLAPACKMatrix;
-
+#  endif
 
 namespace Utilities
 {

diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h
@@ -28,8 +28,11 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 template <int rank, int dim, typename Number = double>
 class SymmetricTensor;
+#endif
 
 template <int dim, typename Number>
 DEAL_II_CONSTEXPR inline DEAL_II_ALWAYS_INLINE SymmetricTensor<2, dim, Number>

diff --git a/include/deal.II/base/table.h b/include/deal.II/base/table.h
@@ -31,6 +31,7 @@
 DEAL_II_NAMESPACE_OPEN
 
 // forward declaration
+#ifndef DOXYGEN
 template <int N, typename T>
 class TableBase;
 template <int N, typename T>
@@ -49,6 +50,7 @@ template <typename T>
 class Table<5, T>;
 template <typename T>
 class Table<6, T>;
+#endif
 
 
 

diff --git a/include/deal.II/base/table_handler.h b/include/deal.II/base/table_handler.h
@@ -36,7 +36,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 class TableHandler;
+#endif
 
 namespace internal
 {

diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h
@@ -38,13 +38,14 @@
 DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations:
-
+#ifndef DOXYGEN
 template <int dim, typename Number>
 class Point;
 template <int rank_, int dim, typename Number = double>
 class Tensor;
 template <typename Number>
 class Vector;
+#endif
 
 #ifndef DOXYGEN
 // Overload invalid tensor types of negative rank that come up during

diff --git a/include/deal.II/base/utilities.h b/include/deal.II/base/utilities.h
@@ -61,8 +61,10 @@ DEAL_II_ENABLE_EXTRA_DIAGNOSTICS
 DEAL_II_NAMESPACE_OPEN
 
 // forward declare Point
+#ifndef DOXYGEN
 template <int dim, typename Number>
 class Point;
+#endif
 
 /**
  * A namespace for utility functions that are not particularly specific to

diff --git a/include/deal.II/distributed/p4est_wrappers.h b/include/deal.II/distributed/p4est_wrappers.h
@@ -38,6 +38,8 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#  ifndef DOXYGEN
 namespace parallel
 {
   namespace distributed
@@ -46,7 +48,7 @@ namespace parallel
     class Triangulation;
   }
 } // namespace parallel
-
+#  endif
 
 namespace internal
 {

diff --git a/include/deal.II/distributed/tria.h b/include/deal.II/distributed/tria.h
@@ -56,6 +56,8 @@ DEAL_II_NAMESPACE_OPEN
 
 #ifdef DEAL_II_WITH_P4EST
 
+// Forward declarations
+#  ifndef DOXYGEN
 namespace internal
 {
   namespace DoFHandlerImplementation
@@ -83,6 +85,7 @@ namespace GridTools
   template <typename CellIterator>
   struct PeriodicFacePair;
 }
+#  endif
 
 namespace parallel
 {

diff --git a/include/deal.II/dofs/block_info.h b/include/deal.II/dofs/block_info.h
@@ -26,14 +26,15 @@
 DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
-
+#ifndef DOXYGEN
 template <int dim, int spacedim>
 class DoFHandler;
 namespace hp
 {
   template <int dim, int spacedim>
   class DoFHandler;
 }
+#endif
 
 
 /**

diff --git a/include/deal.II/dofs/deprecated_function_map.h b/include/deal.II/dofs/deprecated_function_map.h
@@ -22,9 +22,11 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#ifndef DOXYGEN
 template <int spacedim, typename RangeNumberType>
 class Function;
-
+#endif
 
 
 /**

diff --git a/include/deal.II/dofs/dof_accessor.h b/include/deal.II/dofs/dof_accessor.h
@@ -29,6 +29,8 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declarations
+#ifndef DOXYGEN
 template <typename number>
 class FullMatrix;
 template <typename number>
@@ -42,7 +44,6 @@ class TriaRawIterator;
 template <int, int>
 class FiniteElement;
 
-
 namespace internal
 {
   namespace DoFCellAccessorImplementation
@@ -67,6 +68,7 @@ namespace internal
     }
   } // namespace hp
 } // namespace internal
+#endif
 
 // note: the file dof_accessor.templates.h is included at the end of
 // this file.  this includes a lot of templates and thus makes

diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h
@@ -44,6 +44,8 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declarations
+#ifndef DOXYGEN
 template <int dim, int spacedim>
 class FiniteElement;
 template <int dim, int spacedim>
@@ -73,7 +75,7 @@ namespace internal
     struct Implementation;
   }
 } // namespace internal
-
+#endif
 
 /**
  * Given a triangulation and a description of a finite element, this

diff --git a/include/deal.II/dofs/dof_handler_policy.h b/include/deal.II/dofs/dof_handler_policy.h
@@ -32,9 +32,11 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declaration
+#  ifndef DOXYGEN
 template <int, int>
 class DoFHandler;
-
+#  endif
 
 namespace internal
 {

diff --git a/include/deal.II/dofs/dof_iterator_selector.h b/include/deal.II/dofs/dof_iterator_selector.h
@@ -21,6 +21,8 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+// Forward declarations
+#ifndef DOXYGEN
 template <int, int, int>
 class DoFInvalidAccessor;
 
@@ -35,6 +37,7 @@ template <typename Accessor>
 class TriaIterator;
 template <typename Accessor>
 class TriaActiveIterator;
+#endif
 
 namespace internal
 {