[GIT] ppl/ppl(master): Doxygen \relates command can not be used with enumerated types.

31 Mar 2012

Module: ppl/ppl
Branch: master
Commit: b495379843cdc1ba429cef608e79a09757c9a6e7
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=b495379843cdc...
Author: Enea Zaffanella zaffanella@cs.unipr.it
Date:   Sat Mar 31 13:57:10 2012 +0200
Doxygen \relates command can not be used with enumerated types.
Replace it with \name grouping.
---
src/Result.defs.hh          |   22 ++++++++++++++++++++--
 src/Result.inlines.hh       |   12 ++++++------
 src/Rounding_Dir.defs.hh    |   27 ++++++++++++++++++++++++++-
 src/Rounding_Dir.inlines.hh |   26 +++++++++++++-------------
 4 files changed, 65 insertions(+), 22 deletions(-)

diff --git a/src/Result.defs.hh b/src/Result.defs.hh
index 35eac7a..fa2fc2f 100644
--- a/src/Result.defs.hh
+++ b/src/Result.defs.hh
@@ -160,16 +160,34 @@ enum Result {
};
+//! \name Functions Inspecting and/or Combining Result Values
+//@{
+
+/*! \ingroup PPL_CXX_interface */
 Result operator&(Result x, Result y);
+
+/*! \ingroup PPL_CXX_interface */
 Result operator|(Result x, Result y);
+
+/*! \ingroup PPL_CXX_interface */
 Result operator-(Result x, Result y);
-//! Extracts the value class part of \p r (representable number, unrepresentable minus/plus infinity or nan).
+/*! \brief \ingroup PPL_CXX_interface
+  Extracts the value class part of \p r (representable number,
+  unrepresentable minus/plus infinity or nan).
+*/
 Result_Class result_class(Result r);
-//! Extracts the relation part of \p r.
+/*! \brief \ingroup PPL_CXX_interface
+  Extracts the relation part of \p r.
+*/
 Result_Relation result_relation(Result r);
+/*! \ingroup PPL_CXX_interface */
+Result result_relation_class(Result r);
+
+//@} // Functions Inspecting and/or Combining Result Values
+
 } // namespace Parma_Polyhedra_Library
#include "Result.inlines.hh"
diff --git a/src/Result.inlines.hh b/src/Result.inlines.hh
index 5141347..2f22082 100644
--- a/src/Result.inlines.hh
+++ b/src/Result.inlines.hh
@@ -28,42 +28,42 @@ site: http://bugseng.com/products/ppl/ . */
namespace Parma_Polyhedra_Library {
-/*! \relates Parma_Polyhedra_Library::Result */
+/*! \ingroup PPL_CXX_interface */
 inline Result
 operator&(Result x, Result y) {
   unsigned res = static_cast<unsigned>(x) & static_cast<unsigned>(y);
   return static_cast<Result>(res);
 }
-/*! \relates Parma_Polyhedra_Library::Result */
+/*! \ingroup PPL_CXX_interface */
 inline Result
 operator|(Result x, Result y) {
   unsigned res = static_cast<unsigned>(x) | static_cast<unsigned>(y);
   return static_cast<Result>(res);
 }
-/*! \relates Parma_Polyhedra_Library::Result */
+/*! \ingroup PPL_CXX_interface */
 inline Result
 operator-(Result x, Result y) {
   Result y_neg = static_cast<Result>(~static_cast<unsigned>(y));
   return x & y_neg;
 }
-/*! \relates Parma_Polyhedra_Library::Result */
+/*! \ingroup PPL_CXX_interface */
 inline Result_Class
 result_class(Result r) {
   Result rc = r & static_cast<Result>(VC_MASK);
   return static_cast<Result_Class>(rc);
 }
-/*! \relates Parma_Polyhedra_Library::Result */
+/*! \ingroup PPL_CXX_interface */
 inline Result_Relation
 result_relation(Result r) {
   Result rc = r & static_cast<Result>(VR_MASK);
   return static_cast<Result_Relation>(rc);
 }
-/*! \relates Parma_Polyhedra_Library::Result */
+/*! \ingroup PPL_CXX_interface */
 inline Result
 result_relation_class(Result r) {
   return r & (static_cast<Result>(VR_MASK) | static_cast<Result>(VC_MASK));
diff --git a/src/Rounding_Dir.defs.hh b/src/Rounding_Dir.defs.hh
index 15c7d63..f9161f0 100644
--- a/src/Rounding_Dir.defs.hh
+++ b/src/Rounding_Dir.defs.hh
@@ -69,28 +69,53 @@ enum Rounding_Dir {
   ROUND_CHECK = ROUND_DIRECT | ROUND_STRICT_RELATION
 };
+//! \name Functions Inspecting and/or Combining Rounding_Dir Values
+//@{
+
+/*! \ingroup PPL_CXX_interface */
 Rounding_Dir operator&(Rounding_Dir x, Rounding_Dir y);
+
+/*! \ingroup PPL_CXX_interface */
 Rounding_Dir operator|(Rounding_Dir x, Rounding_Dir y);
-/*! \brief
+/*! \brief \ingroup PPL_CXX_interface
   Returns the inverse rounding mode of \p dir,
   <CODE>ROUND_IGNORE</CODE> being the inverse of itself.
 */
 Rounding_Dir inverse(Rounding_Dir dir);
+/*! \ingroup PPL_CXX_interface */
 Rounding_Dir round_dir(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_down(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_up(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_ignore(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_not_needed(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_not_requested(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_direct(Rounding_Dir dir);
+
+/*! \ingroup PPL_CXX_interface */
 bool round_inverse(Rounding_Dir dir);
+/*! \ingroup PPL_CXX_interface */
 bool round_strict_relation(Rounding_Dir dir);
+/*! \ingroup PPL_CXX_interface */
 fpu_rounding_direction_type round_fpu_dir(Rounding_Dir dir);
+//@} // Functions Inspecting and/or Combining Rounding_Dir Values
+
 } // namespace Parma_Polyhedra_Library
#include "Rounding_Dir.inlines.hh"
diff --git a/src/Rounding_Dir.inlines.hh b/src/Rounding_Dir.inlines.hh
index 12b9823..8b50802 100644
--- a/src/Rounding_Dir.inlines.hh
+++ b/src/Rounding_Dir.inlines.hh
@@ -28,69 +28,69 @@ site: http://bugseng.com/products/ppl/ . */
namespace Parma_Polyhedra_Library {
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline Rounding_Dir
 operator&(Rounding_Dir x, Rounding_Dir y) {
   unsigned res = static_cast<unsigned>(x) & static_cast<unsigned>(y);
   return static_cast<Rounding_Dir>(res);
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline Rounding_Dir
 operator|(Rounding_Dir x, Rounding_Dir y) {
   unsigned res = static_cast<unsigned>(x) | static_cast<unsigned>(y);
   return static_cast<Rounding_Dir>(res);
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline Rounding_Dir
 round_dir(Rounding_Dir dir) {
   return dir & ROUND_DIR_MASK;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_down(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_DOWN;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_up(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_UP;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_ignore(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_IGNORE;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_not_needed(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_NOT_NEEDED;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_not_requested(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_IGNORE || round_dir(dir) == ROUND_NOT_NEEDED;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_direct(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_DIRECT;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_inverse(Rounding_Dir dir) {
   return round_dir(dir) == ROUND_INVERSE;
 }
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline bool
 round_strict_relation(Rounding_Dir dir) {
   return (dir & ROUND_STRICT_RELATION) == ROUND_STRICT_RELATION;
@@ -98,7 +98,7 @@ round_strict_relation(Rounding_Dir dir) {
#if PPL_CAN_CONTROL_FPU
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline fpu_rounding_direction_type
 round_fpu_dir(Rounding_Dir dir) {
   switch (round_dir(dir)) {
@@ -120,7 +120,7 @@ round_fpu_dir(Rounding_Dir dir) {
#endif
-/*! \relates Parma_Polyhedra_Library::Rounding_Dir */
+/*! \ingroup PPL_CXX_interface */
 inline Rounding_Dir
 inverse(Rounding_Dir dir) {
   switch (round_dir(dir)) {

    

Enea Zaffanella

tags (0)

participants (1)