From 8a7753d05c58ffc65868ffa1a323a41c5cfd263e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?=
 <mael.rouxel.labbe@geometryfactory.com>
Date: Fri, 22 May 2020 18:55:59 +0200
Subject: [PATCH] Re-add doc of STL functions (from BGL/doc to BGL/include)

---
 BGL/include/CGAL/boost/graph/IO/STL.h | 52 +++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/BGL/include/CGAL/boost/graph/IO/STL.h b/BGL/include/CGAL/boost/graph/IO/STL.h
index 31ad68087cc..b318b1d1ffd 100644
--- a/BGL/include/CGAL/boost/graph/IO/STL.h
+++ b/BGL/include/CGAL/boost/graph/IO/STL.h
@@ -61,6 +61,17 @@ public:
 } // namespace internal
 } // namespace IO
 
+/*!
+  \ingroup PkgBGLIOFct
+
+  reads the graph `g` from data in the STL format.
+
+  \sa Overloads of this function for specific models of the concept `FaceGraph`.
+
+  \pre The data must represent a 2-manifold
+
+  \see \ref IOStreamSTL
+*/
 template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
 bool read_STL(std::istream& in,
               FaceGraph& g,
@@ -74,6 +85,17 @@ bool read_STL(std::istream& in,
   return builder(g, np);
 }
 
+/*!
+  \ingroup PkgBGLIOFct
+
+  reads the graph `g` from the file `fname` in the STL format.
+
+  \sa Overloads of this function for specific models of the concept `FaceGraph`.
+
+  \pre The data must represent a 2-manifold
+
+  \see \ref IOStreamSTL
+*/
 template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
 bool read_STL(const char* fname, FaceGraph& g, const CGAL_BGL_NP_CLASS& np,
               bool verbose = true)
@@ -100,6 +122,21 @@ bool read_STL(const std::string& fname, FaceGraph& g) { return read_STL(fname, g
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 /// Write
 
+
+/*!
+  \ingroup PkgBGLIOFct
+
+  writes the graph `g` in the stream `out` in the STL format.
+
+  \cgalNamedParamsBegin
+    \cgalParamBegin{vertex_point_map} the property map with the points associated to the vertices of `g`.
+      If this parameter is omitted, an internal property map for
+      `CGAL::vertex_point_t` should be available in `FaceGraph`\cgalParamEnd
+  \cgalNamedParamsEnd
+  \pre The graph must contain only triangle faces.
+
+  \see \ref IOStreamSTL
+*/
 template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
 bool write_STL(std::ostream& out,
                const FaceGraph& g,
@@ -172,6 +209,21 @@ bool write_STL(std::ostream& out,
   return out.good();
 }
 
+/*!
+\ingroup PkgBGLIOFct
+
+ writes the graph `g` in the STL format into a file named `fname`.
+
+  \cgalNamedParamsBegin
+    \cgalParamBegin{vertex_point_map} the property map with the points associated to the vertices of `g`.
+      If this parameter is omitted, an internal property map for
+      `CGAL::vertex_point_t` should be available in `FaceGraph`\cgalParamEnd
+  \cgalNamedParamsEnd
+
+ \sa Overloads of this function for specific models of the concept `FaceGraph`.
+
+ \see \ref IOStreamSTL
+*/
 template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
 bool write_STL(const char* fname, const FaceGraph& g, const CGAL_BGL_NP_CLASS& np)
 {