[PPL-devel] [GIT] ppl/ppl(master): Fixed comments that were meant to be Doxygen comments.

Roberto Bagnara bagnara at cs.unipr.it
Sun Aug 19 12:43:24 CEST 2012


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

Author: Roberto Bagnara <bagnara at cs.unipr.it>
Date:   Sun Aug 19 12:42:09 2012 +0200

Fixed comments that were meant to be Doxygen comments.
Detected by ECLAIR service cmntdecl_srceline.

---

 src/BD_Shape.defs.hh                           |   57 ++++++++++++-----------
 src/Opposite_Floating_Point_Expression.defs.hh |   28 ++++++------
 src/checked.cc                                 |    8 ++--
 3 files changed, 48 insertions(+), 45 deletions(-)

diff --git a/src/BD_Shape.defs.hh b/src/BD_Shape.defs.hh
index b6b17ef..7f8c4d9 100644
--- a/src/BD_Shape.defs.hh
+++ b/src/BD_Shape.defs.hh
@@ -2214,64 +2214,67 @@ private:
                                Coefficient_traits::const_reference sc_denom,
                                const N& ub_v);
 
-  /* \brief
+  /*! \brief
     Auxiliary function for \ref affine_form_relation "affine form image" that
     handle the general case: \f$l \equal c\f$
   */
   template <typename Interval_Info>
   void inhomogeneous_affine_form_image(const dimension_type& var_id,
-                                                       const Interval<T, Interval_Info>& b);
+                                       const Interval<T, Interval_Info>& b);
 
-  /* \brief
-    Auxiliary function for \ref affine_form_relation "affine form image" that
-    handle the general case: \f$l \equal ax + c\f$
+  /*! \brief
+    Auxiliary function for \ref affine_form_relation "affine form
+    image" that handle the general case: \f$l \equal ax + c\f$
   */
   template <typename Interval_Info>
-  void one_variable_affine_form_image(const dimension_type& var_id,
-                               const Interval<T, Interval_Info>& b,
-                               const Interval<T, Interval_Info>& w_coeff,
-                               const dimension_type& w_id,
-                               const dimension_type& space_dim);
+  void one_variable_affine_form_image
+  (const dimension_type& var_id,
+   const Interval<T, Interval_Info>& b,
+   const Interval<T, Interval_Info>& w_coeff,
+   const dimension_type& w_id,
+   const dimension_type& space_dim);
 
-  /* \brief
+  /*! \brief
     Auxiliary function for \ref affine_form_relation "affine form image" that
     handle the general case: \f$l \equal ax + by + c\f$
   */
   template <typename Interval_Info>
-  void two_variables_affine_form_image(const dimension_type& var_id,
-                 const Linear_Form<Interval<T,Interval_Info> >& lf,
-                                   const dimension_type& space_dim);
+  void two_variables_affine_form_image
+  (const dimension_type& var_id,
+   const Linear_Form<Interval<T,Interval_Info> >& lf,
+   const dimension_type& space_dim);
 
-  /* \brief
+  /*! \brief
     Auxiliary function for refine with linear form that handle
     the general case: \f$l \equal 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);
+                                 const Linear_Form<Interval<T, Interval_Info> >& left,
+                                 const Linear_Form<Interval<T, Interval_Info> >& right);
 
-  /* \brief
+  /*! \brief
     Auxiliary function for refine with linear form that handle
     the general case: \f$ax +b \equal cy + d\f$
   */
   template <typename Interval_Info>
-  void left_one_var_refine(const dimension_type& left_w_id,
-                           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_one_var_refine
+  (const dimension_type& left_w_id,
+   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
+  /*! \brief
     Auxiliary function for refine with linear form that handle
     the general case.
   */
   template <typename Interval_Info>
   void general_refine(const dimension_type& left_w_id,
-                           const dimension_type& right_w_id,
-                   const Linear_Form<Interval<T, Interval_Info> >& left,
-                   const Linear_Form<Interval<T, Interval_Info> >& right);
+                      const dimension_type& right_w_id,
+                      const Linear_Form<Interval<T, Interval_Info> >& left,
+                      const Linear_Form<Interval<T, Interval_Info> >& right);
 
   template <typename Interval_Info>
   void linear_form_upper_bound(const Linear_Form<Interval<T, Interval_Info> >&
diff --git a/src/Opposite_Floating_Point_Expression.defs.hh b/src/Opposite_Floating_Point_Expression.defs.hh
index 4904364..972477e 100644
--- a/src/Opposite_Floating_Point_Expression.defs.hh
+++ b/src/Opposite_Floating_Point_Expression.defs.hh
@@ -83,40 +83,40 @@ class Opposite_Floating_Point_Expression
 
 public:
 
-  /* \brief
-     Alias for the Linear_Form<FP_Interval_Type> from
-     Floating_Point_Expression
+  /*! \brief
+    Alias for the Linear_Form<FP_Interval_Type> from
+    Floating_Point_Expression
   */
   typedef typename
   Floating_Point_Expression<FP_Interval_Type, FP_Format>::
   FP_Linear_Form FP_Linear_Form;
 
-  /* \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
-     Floating_Point_Expression.
+  /*! \brief
+    Alias for the std::map<dimension_type, FP_Interval_Type> from
+    Floating_Point_Expression.
   */
   typedef typename
   Floating_Point_Expression<FP_Interval_Type, FP_Format>::
   FP_Interval_Abstract_Store FP_Interval_Abstract_Store;
 
-  /* \brief
-     Alias for the std::map<dimension_type, FP_Linear_Form> from
-     Floating_Point_Expression.
+  /*! \brief
+    Alias for the std::map<dimension_type, FP_Linear_Form> from
+    Floating_Point_Expression.
   */
   typedef typename
   Floating_Point_Expression<FP_Interval_Type, FP_Format>::
   FP_Linear_Form_Abstract_Store FP_Linear_Form_Abstract_Store;
 
-  /* \brief
-     Alias for the FP_Interval_Type::boundary_type from
-     Floating_Point_Expression.
+  /*! \brief
+    Alias for the FP_Interval_Type::boundary_type from
+    Floating_Point_Expression.
   */
   typedef typename
   Floating_Point_Expression<FP_Interval_Type, FP_Format>::boundary_type
   boundary_type;
 
-  /* \brief
-     Alias for the FP_Interval_Type::info_type from Floating_Point_Expression.
+  /*! \brief
+    Alias for the FP_Interval_Type::info_type from Floating_Point_Expression.
   */
   typedef typename
   Floating_Point_Expression<FP_Interval_Type, FP_Format>::info_type info_type;
diff --git a/src/checked.cc b/src/checked.cc
index bd6c118..80edd66 100644
--- a/src/checked.cc
+++ b/src/checked.cc
@@ -339,10 +339,10 @@ parse_number_part(std::istream& is, number_struct& numer) {
   return V_CVT_STR_UNK;
 }
 
-/* \brief
-   Reads a number from \p is writing it into \p numer, the numerator,
-   and \p denom, the denominator; the appropriate Result value is
-   returned.
+/*! \brief
+  Reads a number from \p is writing it into \p numer, the numerator,
+  and \p denom, the denominator; the appropriate Result value is
+  returned.
 */
 Result
 parse_number(std::istream& is, number_struct& numer, number_struct& denom) {




More information about the PPL-devel mailing list