[PPL-devel] Patch for Polyhedron::shrink_bounding_box() documentation

[Andrea Pescetti]

You can apply the following patch to improve the documentation of
Polyhedron::shrink_bounding_box() as discussed in
http://www.cs.unipr.it/pipermail/ppl-devel/2005-July/006191.html

Tested with Doxygen 1.4.5.

  --- patch begin
Index: Polyhedron.defs.hh
===================================================================
RCS file: /cvs/ppl/ppl/src/Polyhedron.defs.hh,v
retrieving revision 1.283
diff -c -d -r1.283 Polyhedron.defs.hh
*** Polyhedron.defs.hh  22 Sep 2005 16:08:58 -0000      1.283
--- Polyhedron.defs.hh  4 Oct 2005 20:00:13 -0000
***************
*** 728,733 ****
--- 728,741 ----
      \param complexity
      The complexity class of the algorithm to be used.
   
+     First, the smallest bounding box \f$B\f$ containing the polyhedron
+     is computed; then \p box is (destructively) intersected with
+     \f$B\f$ by using only the methods of Box listed in the
+     documentation.
+
+     Notice that there is no way <CODE>shrink_bounding_box()</CODE>
+     can obtain information from the \p box parameter.
+
      The template class Box must provide the following methods, whose
      return values, if any, are simply ignored.
      \code
  --- patch end
Yours,
  Andrea.