Merge branch 'cherry-pick-3ea2d323' into 'releases/2.5'

Merge branch 'feature/mark-internal-classes-as-internal' into 'master'

Mark various implementation classes as 'internal'

By using the doxygen \internal command.

See merge request !70

See merge request !71

dune/istl/basearray.hh

@@ -39,6 +39,8 @@ namespace Dune {
    \todo There shouldn't be an allocator argument here, because the array is 'unmanaged'.
          And indeed, of the allocator, only its size_type is used.  Hence, the signature
          of this class should be changed to <class B, int stype>
+
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class base_array_unmanaged
@@ -270,6 +272,7 @@ namespace Dune {
            Error checking: no error checking is provided normally.
            Setting the compile time switch DUNE_ISTL_WITH_CHECKING
            enables error checking.
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class base_array_window : public base_array_unmanaged<B,A>
@@ -360,6 +363,7 @@ namespace Dune {
             Error checking: no error checking is provided normally.
             Setting the compile time switch DUNE_ISTL_WITH_CHECKING
             enables error checking.
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class base_array : public base_array_unmanaged<B,A>
@@ -515,6 +519,8 @@ namespace Dune {
            Error checking: no error checking is provided normally.
            Setting the compile time switch DUNE_ISTL_WITH_CHECKING
            enables error checking.
+
+    \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class compressed_base_array_unmanaged

dune/istl/bvector.hh

@@ -38,6 +38,8 @@ namespace Dune {
           Error checking: no error checking is provided normally.
           Setting the compile time switch DUNE_ISTL_WITH_CHECKING
           enables error checking.
+
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class block_vector_unmanaged : public base_array_unmanaged<B,A>
@@ -636,6 +638,8 @@ namespace Dune {
           Error checking: no error checking is provided normally.
           Setting the compile time switch DUNE_ISTL_WITH_CHECKING
           enables error checking.
+
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
 #ifndef DOXYGEN
   template<class B, class A>
@@ -759,6 +763,8 @@ namespace Dune {
           Error checking: no error checking is provided normally.
           Setting the compile time switch DUNE_ISTL_WITH_CHECKING
           enables error checking.
+
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class compressed_block_vector_unmanaged : public compressed_base_array_unmanaged<B,A>
@@ -1011,6 +1017,8 @@ namespace Dune {
           Error checking: no error checking is provided normally.
           Setting the compile time switch DUNE_ISTL_WITH_CHECKING
           enables error checking.
+
+   \internal This class is an implementation detail, and should not be used outside of dune-istl.
    */
   template<class B, class A=std::allocator<B> >
   class CompressedBlockVectorWindow : public compressed_block_vector_unmanaged<B,A>