[PPL-devel] [GIT] ppl/ppl(master): Fixed several Doxygen warnings.

[Enea Zaffanella]

Module: ppl/ppl
Branch: master
Commit: 5572ab3e057147db50a731e35136bbdea36f587e
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=5572ab3e057147db50a731e35136bbdea36f587e

Author: Enea Zaffanella <zaffanella at cs.unipr.it>
Date:   Wed Sep  5 14:18:09 2012 +0200

Fixed several Doxygen warnings.

---

 src/BD_Shape_defs.hh                  |   19 ++++++++++---------
 src/Concrete_Expression_types.hh      |   30 +++++++++++++++---------------
 src/Partially_Reduced_Product_defs.hh |    2 +-
 3 files changed, 26 insertions(+), 25 deletions(-)

diff --git a/src/BD_Shape_defs.hh b/src/BD_Shape_defs.hh
index cf5d24b..891c122 100644
--- a/src/BD_Shape_defs.hh
+++ b/src/BD_Shape_defs.hh
@@ -2216,7 +2216,7 @@ private:
 
   /*! \brief
     Auxiliary function for \ref affine_form_relation "affine form image" that
-    handle the general case: \f$l \equal c\f$
+    handle the general case: \f$l = c\f$
   */
   template <typename Interval_Info>
   void inhomogeneous_affine_form_image(const dimension_type& var_id,
@@ -2224,7 +2224,7 @@ private:
 
   /*! \brief
     Auxiliary function for \ref affine_form_relation "affine form
-    image" that handle the general case: \f$l \equal ax + c\f$
+    image" that handle the general case: \f$l = ax + c\f$
   */
   template <typename Interval_Info>
   void one_variable_affine_form_image
@@ -2236,7 +2236,7 @@ private:
 
   /*! \brief
     Auxiliary function for \ref affine_form_relation "affine form image" that
-    handle the general case: \f$l \equal ax + by + c\f$
+    handle the general case: \f$l = ax + by + c\f$
   */
   template <typename Interval_Info>
   void two_variables_affine_form_image
@@ -2246,17 +2246,18 @@ private:
 
   /*! \brief
     Auxiliary function for refine with linear form that handle
-    the general case: \f$l \equal ax + c\f$
+    the general case: \f$l = ax + c\f$
   */
   template <typename Interval_Info>
-  void left_inhomogeneous_refine(const dimension_type& right_t,
-                                 const dimension_type& right_w_id,
-                                 const Linear_Form<Interval<T, Interval_Info> >& left,
-                                 const Linear_Form<Interval<T, Interval_Info> >& right);
+  void left_inhomogeneous_refine
+  (const dimension_type& right_t,
+   const dimension_type& right_w_id,
+   const Linear_Form<Interval<T, Interval_Info> >& left,
+   const Linear_Form<Interval<T, Interval_Info> >& right);
 
   /*! \brief
     Auxiliary function for refine with linear form that handle
-    the general case: \f$ax +b \equal cy + d\f$
+    the general case: \f$ax + b = cy + d\f$
   */
   template <typename Interval_Info>
   void left_one_var_refine
diff --git a/src/Concrete_Expression_types.hh b/src/Concrete_Expression_types.hh
index 12f3b7d..c15a98e 100644
--- a/src/Concrete_Expression_types.hh
+++ b/src/Concrete_Expression_types.hh
@@ -21,44 +21,44 @@ namespace Parma_Polyhedra_Library {
   This justifies (here below) the explicit use of Doxygen command \class.
 */
 
-/*! \class Parma_Polyhedra_Library::Concrete_Expression \brief
-  The base class of all concrete expressions.
+/*! \brief The base class of all concrete expressions.
+  \class Parma_Polyhedra_Library::Concrete_Expression
 */
 template <typename Target>
 class Concrete_Expression;
 
-/*! \class Parma_Polyhedra_Library::Binary_Operator \brief
-  A binary operator applied to two concrete expressions.
+/*! \brief A binary operator applied to two concrete expressions.
+  \class Parma_Polyhedra_Library::Binary_Operator
 */
 template <typename Target>
 class Binary_Operator;
 
-/*! \class Parma_Polyhedra_Library::Unary_Operator \brief
-  A unary operator applied to one concrete expression.
+/*! \brief A unary operator applied to one concrete expression.
+  \class Parma_Polyhedra_Library::Unary_Operator
 */
 template <typename Target>
 class Unary_Operator;
 
-/*! \class Parma_Polyhedra_Library::Cast_Operator \brief
-  A cast operator converting one concrete expression to some type.
+/*! \brief A cast operator converting one concrete expression to some type.
+  \class Parma_Polyhedra_Library::Cast_Operator
 */
 template <typename Target>
 class Cast_Operator;
 
-/*! \class Parma_Polyhedra_Library::Integer_Constant \brief
-  An integer constant concrete expression.
+/*! \brief An integer constant concrete expression.
+  \class Parma_Polyhedra_Library::Integer_Constant
 */
 template <typename Target>
 class Integer_Constant;
 
-/*! \class Parma_Polyhedra_Library::Floating_Point_Constant \brief
-  A floating-point constant concrete expression.
+/*! \brief A floating-point constant concrete expression.
+  \class Parma_Polyhedra_Library::Floating_Point_Constant
 */
 template <typename Target>
 class Floating_Point_Constant;
 
-/*! \class Parma_Polyhedra_Library::Approximable_Reference \brief
-  A concrete expression representing a reference to some approximable.
+/*! \brief A concrete expression representing a reference to some approximable.
+  \class Parma_Polyhedra_Library::Approximable_Reference
 */
 template <typename Target>
 class Approximable_Reference;
@@ -73,7 +73,7 @@ class Concrete_Expression_Type;
   Cast_Operator, Integer_Constant, Floating_Point_Constant, or
   Approximable_Reference.  For example, the Binary_Operator kind
   integer constant should be defined by an instance as the member
-  <CODE>Binary_Operator\<T\>::KIND</CODE>
+  <CODE>Binary_Operator\<T\>::%KIND</CODE>.
 */
 typedef int Concrete_Expression_Kind;
 
diff --git a/src/Partially_Reduced_Product_defs.hh b/src/Partially_Reduced_Product_defs.hh
index 3287029..2916f72 100644
--- a/src/Partially_Reduced_Product_defs.hh
+++ b/src/Partially_Reduced_Product_defs.hh
@@ -1659,7 +1659,7 @@ namespace Parma_Polyhedra_Library {
   be supported in C++.
 
   When template typedefs will be supported in C++, what now is verbosely
-  denoted by <CODE>Domain_Product\<Domain1, Domain2\>::Direct_Product</CODE>
+  denoted by <CODE>Domain_Product\<Domain1, Domain2\>::%Direct_Product</CODE>
   will simply be denoted by <CODE>Direct_Product\<Domain1, Domain2\></CODE>.
 */
 template <typename D1, typename D2>