From 98ca0fdbb1358b72dd2f72bd00a87778f6c149ce Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Fri, 5 Oct 2012 07:47:27 +0000
Subject: [PATCH] Improve deprecation warning; now it's easier to get the
 reason for the warning and to find deprecated headers. Add deprecation flag
 in doxygen.

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@9211 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
 dumux/material/components/oil.hh                           | 4 +++-
 dumux/material/components/simplednapl.hh                   | 4 +++-
 dumux/material/spatialparameters/boxspatialparameters.hh   | 4 +++-
 dumux/material/spatialparameters/boxspatialparameters1p.hh | 4 +++-
 dumux/material/spatialparameters/fvspatialparameters.hh    | 4 +++-
 dumux/material/spatialparameters/fvspatialparameters1p.hh  | 4 +++-
 6 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/dumux/material/components/oil.hh b/dumux/material/components/oil.hh
index 7a15e789b8..b0a4e40b2c 100644
--- a/dumux/material/components/oil.hh
+++ b/dumux/material/components/oil.hh
@@ -24,7 +24,7 @@
 #ifndef DUMUX_OIL_HH
 #define DUMUX_OIL_HH
 
-#warning use material/components/lnapl.hh instead
+#warning oil.hh is deprecated, use material/components/lnapl.hh instead
 
 #include "lnapl.hh"
 
@@ -35,6 +35,8 @@ namespace Dumux
  *
  * \brief Rough estimate for testing purposes of some oil.
  *
+ * \deprecated Use LNAPL instead.
+ * 
  * \tparam Scalar The type used for scalar values
  */
 template <class Scalar>
diff --git a/dumux/material/components/simplednapl.hh b/dumux/material/components/simplednapl.hh
index 0cbb794741..5e5d67227f 100644
--- a/dumux/material/components/simplednapl.hh
+++ b/dumux/material/components/simplednapl.hh
@@ -24,7 +24,7 @@
 #ifndef DUMUX_SIMPLE_DNAPL_HH
 #define DUMUX_SIMPLE_DNAPL_HH
 
-#warning use material/components/dnapl.hh instead
+#warning simplenapl.hh is deprecated, use material/components/dnapl.hh instead
 
 #include "dnapl.hh"
 
@@ -34,6 +34,8 @@ namespace Dumux
  * \ingroup Components
  * \brief A much simple component for an exemplary dense NAPL (TCE).
  *
+ * \deprecated Use DNAPL instead.
+ * 
  * \tparam Scalar The type used for scalar values
  */
 template <class Scalar>
diff --git a/dumux/material/spatialparameters/boxspatialparameters.hh b/dumux/material/spatialparameters/boxspatialparameters.hh
index a6b4719391..47ac4fe93d 100644
--- a/dumux/material/spatialparameters/boxspatialparameters.hh
+++ b/dumux/material/spatialparameters/boxspatialparameters.hh
@@ -21,13 +21,15 @@
 
 #include <dumux/material/spatialparams/boxspatialparams.hh>
 
-#warning include dumux/material/spatialparams/boxspatialparams.hh instead
+#warning boxspatialparameters.hh is deprecated, include dumux/material/spatialparams/boxspatialparams.hh instead
 
 namespace Dumux {
 
 /**
  * \brief The base class for spatial parameters of problems using the
  *        box method.
+ * 
+ * \deprecated Use BoxSpatialParams instead.
  */
 template<class TypeTag>
 class BoxSpatialParameters: public BoxSpatialParams<TypeTag>
diff --git a/dumux/material/spatialparameters/boxspatialparameters1p.hh b/dumux/material/spatialparameters/boxspatialparameters1p.hh
index 56dd34146e..41f0aa0bbd 100644
--- a/dumux/material/spatialparameters/boxspatialparameters1p.hh
+++ b/dumux/material/spatialparameters/boxspatialparameters1p.hh
@@ -21,13 +21,15 @@
 
 #include <dumux/material/spatialparams/boxspatialparams1p.hh>
 
-#warning include dumux/material/spatialparams/boxspatialparams1p.hh instead
+#warning boxspatialparameters1p.hh is deprecated, include dumux/material/spatialparams/boxspatialparams1p.hh instead
 
 namespace Dumux {
 
 /**
  * \brief The base class for spatial parameters of problems using the
  *        box method.
+ * 
+ * \deprecated Use BoxSpatialParamsOneP instead.
  */
 template<class TypeTag>
 class BoxSpatialParametersOneP : public BoxSpatialParamsOneP<TypeTag>
diff --git a/dumux/material/spatialparameters/fvspatialparameters.hh b/dumux/material/spatialparameters/fvspatialparameters.hh
index a91533dbca..ca70651016 100644
--- a/dumux/material/spatialparameters/fvspatialparameters.hh
+++ b/dumux/material/spatialparameters/fvspatialparameters.hh
@@ -21,7 +21,7 @@
 
 #include <dumux/material/spatialparams/fvspatialparams.hh>
 
-#warning include dumux/material/spatialparams/fvspatialparams.hh instead
+#warning fvspatialparameters.hh is deprecated, include dumux/material/spatialparams/fvspatialparams.hh instead
 
 namespace Dumux
 {
@@ -29,6 +29,8 @@ namespace Dumux
 /**
  * \brief The base class for spatial parameters of a multi-phase problem using the
  *        fv method.
+ * 
+ * \deprecated Use FVSpatialParams instead.
  */
 template<class TypeTag>
 class FVSpatialParameters: public FVSpatialParams<TypeTag>
diff --git a/dumux/material/spatialparameters/fvspatialparameters1p.hh b/dumux/material/spatialparameters/fvspatialparameters1p.hh
index 436d4660ae..ba97dab39e 100644
--- a/dumux/material/spatialparameters/fvspatialparameters1p.hh
+++ b/dumux/material/spatialparameters/fvspatialparameters1p.hh
@@ -21,7 +21,7 @@
 
 #include <dumux/material/spatialparams/fvspatialparams1p.hh>
 
-#warning include dumux/material/spatialparams/fvspatialparams1p.hh instead
+#warning fvspatialparameters1p.hh is deprecated, include dumux/material/spatialparams/fvspatialparams1p.hh instead
 
 namespace Dumux
 {
@@ -29,6 +29,8 @@ namespace Dumux
 /**
  * \brief The base class for spatial parameters of problems using the
  *        fv method.
+ * 
+ * \deprecated Use FVSpatialParamsOneP instead.
  */
 template<class TypeTag>
 class FVSpatialParametersOneP : public FVSpatialParamsOneP<TypeTag>
-- 
GitLab