Merge branch 'Hyperbolic_surface_triangulation_2-dubois' of github.co…

…m:loic-dubois/cgal into Hyperbolic_surface_triangulation_2-dubois

Hyperbolic_surface_triangulation_2/doc/Hyperbolic_surface_triangulation_2/CGAL/Hyperbolic_fundamental_domain_2.h

@@ -29,15 +29,15 @@ class Hyperbolic_fundamental_domain_2 {
   Hyperbolic_fundamental_domain_2();
 
   /*!
-    Constructor from vertices and pairings ranges. 
-    @tparam PointRange a model of the concepts `RandomAccessContainer` whose `value_type` is Point.
-    @tparam PairingRange a model of the concepts `RandomAccessContainer` whose `value_type` is int.
+    Constructor from vertices and pairings ranges.
+    @tparam PointRange a model of the concepts `RandomAccessContainer` whose `value_type` is `Point`.
+    @tparam PairingRange a model of the concepts `RandomAccessContainer` whose `value_type` is `int`.
   */
-     template<class PointRange, class PairingRange> 
+     template<class PointRange, class PairingRange>
        Hyperbolic_fundamental_domain_2(PointRange & vertices, PairingRange & pairings);
   /// @}
 
-  /// \name Access functions
+  /// \name Access Functions
   /// @{
   /*!
       returns the number of vertices (equivalently, the number of sides) of the domain.
@@ -69,28 +69,26 @@ class Hyperbolic_fundamental_domain_2 {
   Hyperbolic_isometry_2<Traits> side_pairing(int i) const;
   /// @}
 
-  /// \name Input/output
+  /// \name Input/Output
   /// @{
-  /*!
-      Reads the domain from a stream.
-
-      The format of the input should be the same as the format of the output of the 'from_stream' method.
-
-      \pre <code> is_valid() </code>
-  */
-  std::istream& operator>>(std::istream& s, Hyperbolic_fundamental_domain_2<Traits>& domain);
-
   /*!
       writes the domain in a stream.
 
       The format of the output is the following.
-      The first line prints the number n of vertices of the domain.
+      The first line prints the number \f$n\f$ of vertices of the domain.
       For \f$ i=0 \f$ to \f$ n-1 \f$ the index of the side paired to side \f$ i \f$ is printed on a separate line.
       For \f$ i=0 \f$ to \f$ n-1 \f$ the \f$ i \f$-th vertex is printed on a separate line.
 
       \pre <code> is_valid() </code>
   */
   std::ostream& operator<<(std::ostream& s, const Hyperbolic_fundamental_domain_2<Traits>& domain);
+
+  /*!
+      Reads the domain from a stream.
+
+      The format of the input must be the same as the format of the output of 'operator<<()'.
+  */
+  std::istream& operator>>(std::istream& s, Hyperbolic_fundamental_domain_2<Traits>& domain);
   /// @}
 
   /// @{

Hyperbolic_surface_triangulation_2/doc/Hyperbolic_surface_triangulation_2/CGAL/Hyperbolic_isometry_2.h

@@ -54,7 +54,7 @@ class Hyperbolic_isometry_2{
     */
     void set_coefficient(int index, const Complex_number& coefficient);
 
-    /// \name Access functions
+    /// \name Access Functions
     /// @{
     /*!
       returns the index-th coefficient.

Hyperbolic_surface_triangulation_2/doc/Hyperbolic_surface_triangulation_2/CGAL/Hyperbolic_surface_triangulation_2.h

@@ -95,7 +95,7 @@ class Hyperbolic_surface_triangulation_2{
   Hyperbolic_surface_triangulation_2& operator=(Hyperbolic_surface_triangulation_2 other);
   /// @}
 
-  /// \name Access functions
+  /// \name Access Functions
   /// @{
   /*!
       returns the decorated combinatorial map.
@@ -126,7 +126,7 @@ class Hyperbolic_surface_triangulation_2{
   /// @}
 
 
-  /// \name Delaunay flip algorithm
+  /// \name Delaunay Flip Algorithm
   /// @{
   /*!
       tells if if the edge supported by the dart is Delaunay flippable.
@@ -178,7 +178,7 @@ class Hyperbolic_surface_triangulation_2{
   bool is_valid() const;
   /// @}
 
-  /// \name Input/output
+  /// \name Input/Output
   /// @{
   /*!
       writes the triangulation in a stream.

Hyperbolic_surface_triangulation_2/doc/Hyperbolic_surface_triangulation_2/Concepts/ComplexWithoutSqrt.h

@@ -37,7 +37,7 @@ class ComplexWithoutSqrt {
   ComplexWithoutSqrt(const FT& real_part, const FT& imaginary_part);
   /// @}
 
-  /// \name Get and set
+  /// \name Get and Set
   /// @{
   /*!
     sets the real part to <code> real_part </code>.

Hyperbolic_surface_triangulation_2/include/CGAL/Hyperbolic_fundamental_domain_2.h

@@ -41,12 +41,12 @@ class Hyperbolic_fundamental_domain_2 {
   /* template<class PointRange, class PairingRange>  */
   /*   Hyperbolic_fundamental_domain_2(PointRange vertices, */
   /*                                   PairingRange pairings); */
-  template<class PointRange, class PairingRange> 
+  template<class PointRange, class PairingRange>
     Hyperbolic_fundamental_domain_2(PointRange & vertices, PairingRange & pairings){
       _vertices = std::vector<Point>(vertices.begin(), vertices.end());
       _pairings = std::vector<int>(pairings.begin(), pairings.end());
   }
- 
+
   int size() const; // Returns the number of vertices (equivalently, the number of sides)
   const Point& vertex(int index) const; // Returns the index-th vertex
   int paired_side(int index) const; // Returns the index of the side paired to side A, where A is the index-th side

Hyperbolic_surface_triangulation_2/include/CGAL/Hyperbolic_fundamental_domain_factory_2.h

@@ -25,9 +25,9 @@ namespace CGAL {
 
 /*
 Factory class, whose only purpose is to construct random fundamental domains of
-closed orientable hyperbolic surfaces. The method
-make_hyperbolic_fundamental_domain_g2 constructs such a domain for a surface of
-genus 2. 
+closed orientable hyperbolic surfaces. The function
+`make_hyperbolic_fundamental_domain_g2()` constructs such a domain for a surface of
+genus 2.
 */
 template<class Traits>
 class Hyperbolic_fundamental_domain_factory_2{

Hyperbolic_surface_triangulation_2/package_info/Hyperbolic_surface_triangulation_2/dependencies

@@ -24,4 +24,3 @@ Property_map
 Random_numbers
 STL_Extension
 Stream_support
-Hyperbolic_triangulation_2