[PPL-devel] [GIT] ppl/ppl(floating_point): Update variale and constant documentations

[Fabio Biselli]

Module: ppl/ppl
Branch: floating_point
Commit: 606ec45118cc8866cff182d49498fb641eb44c95
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=606ec45118cc8866cff182d49498fb641eb44c95

Author: Fabio Biselli <fabio.biselli at studenti.unipr.it>
Date:   Tue Sep  8 16:59:35 2009 +0200

Update variale and constant documentations

---

 src/Constant_Floating_Point_Expression.defs.hh |   20 +++++++++++++-------
 src/Variable_Floating_Point_Expression.defs.hh |   18 +++++++++++-------
 2 files changed, 24 insertions(+), 14 deletions(-)

diff --git a/src/Constant_Floating_Point_Expression.defs.hh b/src/Constant_Floating_Point_Expression.defs.hh
index 0ddfbbf..6fd3ee1 100644
--- a/src/Constant_Floating_Point_Expression.defs.hh
+++ b/src/Constant_Floating_Point_Expression.defs.hh
@@ -43,8 +43,10 @@ void swap(Parma_Polyhedra_Library::Constant_Floating_Point_Expression<
 
 namespace Parma_Polyhedra_Library {
 
-//! A generic Constant Floating Point Expression
-/*! \ingroup PPL_CXX_interface
+/*! \brief
+  A generic Constant Floating Point Expression.
+
+  \ingroup PPL_CXX_interface
 
   \par Template type parameters
 
@@ -109,11 +111,15 @@ public:
 
     // FIXME: Modify documentation when exceptions are fixed.
   /*! \brief
-     Modifies a linear form \p result in the abstract store \p store
-     corresponding to an inhomogenous term which over-approximates
-     *this.value.
-     \param store The abstract store.
-     \param result The linear form that will be modified.
+    Linearizes the expression in a given astract state.
+
+    Modifies a linear form \p result in the abstract store \p store
+    corresponding to an inhomogenous term which over-approximates
+    *this.value.
+
+    \param int_store Interval floating-point store.
+    \param lf_store Linear form store.
+    \param result The modified linear form.
 
      \exception Parma_Polyhedra_Library::Linearization_Failed
     Thrown if the method <CODE>linearize</CODE> fails.
diff --git a/src/Variable_Floating_Point_Expression.defs.hh b/src/Variable_Floating_Point_Expression.defs.hh
index cb1c300..bffb35b 100644
--- a/src/Variable_Floating_Point_Expression.defs.hh
+++ b/src/Variable_Floating_Point_Expression.defs.hh
@@ -43,8 +43,10 @@ void swap(Parma_Polyhedra_Library::Variable_Floating_Point_Expression<
 
 namespace Parma_Polyhedra_Library {
 
-//! A generic Variable Floating Point Expression
-/*! \ingroup PPL_CXX_interface
+/*! \brief
+  A generic Variable Floating Point Expression.
+
+\ingroup PPL_CXX_interface
 
   \par Template type parameters
 
@@ -106,13 +108,15 @@ public:
 
   //@} // Constructors and Destructor
 
-  //! Linearization of a variable.
   /*! \brief
-     Modifies a linear form \p result in the abstract store \p store
-     corresponding to <CODE>this</CODE> variable with coefficent \f$[1,1]\f$.
+    Linearization of a variable.
+
+    Modifies a linear form \p result in the abstract store \p store
+    corresponding to <CODE>this</CODE> variable with coefficent \f$[1,1]\f$.
 
-     \param store The abstract store.
-     \param result The linear form that will be modified.
+    \param int_store Interval floating-point store.
+    \param lf_store Linear form store.
+    \param result The modfied linear form.
   */
   void linearize(const FP_Interval_Abstract_Store& int_store,
                  const FP_Linear_Form_Abstract_Store& lf_store,