From 0e81f39e071f5a85cc0e03afc48944b2dd5bcaaa Mon Sep 17 00:00:00 2001
From: Simon Giraudot <simon.giraudot@geometryfactory.com>
Date: Thu, 14 Dec 2017 10:20:42 +0100
Subject: [PATCH] Document parameters() in CGAL::Point_set_3

---
 Point_set_3/doc/Point_set_3/Doxyfile.in | 12 ++++++++++++
 Point_set_3/include/CGAL/Point_set_3.h  | 21 +++++++++++++++++++--
 2 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/Point_set_3/doc/Point_set_3/Doxyfile.in b/Point_set_3/doc/Point_set_3/Doxyfile.in
index 7b3039d1612..f8f68dc613a 100644
--- a/Point_set_3/doc/Point_set_3/Doxyfile.in
+++ b/Point_set_3/doc/Point_set_3/Doxyfile.in
@@ -1,2 +1,14 @@
 @INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
 PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 3D Point Set"
+
+# macros to be used inside the code
+ALIASES += "cgalNamedParamsBegin=<dl class=\"params\"><dt>Named Parameters</dt><dd> <table class=\"params\">"
+ALIASES += "cgalNamedParamsEnd=</table> </dd> </dl>"
+ALIASES += "cgalParamBegin{1}=<tr><td class=\"paramname\">\ref PSP_\1 \"\1\"</td><td>"
+ALIASES += "cgalParamEnd=</td></tr>"
+
+#macros for NamedParameters.txt
+ALIASES += "cgalNPTableBegin=<dl class=\"params\"><dt></dt><dd> <table class=\"params\">"
+ALIASES += "cgalNPTableEnd=</table> </dd> </dl>"
+ALIASES += "cgalNPBegin{1}=<tr><td class=\"paramname\">\1 </td><td>"
+ALIASES += "cgalNPEnd=</td></tr>"
diff --git a/Point_set_3/include/CGAL/Point_set_3.h b/Point_set_3/include/CGAL/Point_set_3.h
index 792f3fc5087..8ca128407f7 100644
--- a/Point_set_3/include/CGAL/Point_set_3.h
+++ b/Point_set_3/include/CGAL/Point_set_3.h
@@ -837,6 +837,22 @@ public:
     return out;
   }
 
+  /*!
+    \brief Returns a sequence of \ref psp_namedparameters "Named Parameters" for Point Set Processing algorithms.
+
+    \cgalNamedParamsBegin
+      \cgalParamBegin{point_map} contains the point map (see `point_map()`)\cgalParamEnd
+      \cgalParamBegin{normal_map} contains the normal map (see `normal_map()`)\cgalParamEnd
+      \cgalParamBegin{geom_traits} contains the kernel `typename Kernel_traits<Point>`::`Kernel`\cgalParamEnd
+    \cgalNamedParamsEnd
+
+    \warning this method does not check if the normal map was
+    instanciated or not. The normal map named parameter should not be
+    used if this property was not instanciated first.
+  */
+#ifdef DOXYGEN_RUNNING
+  unspecified_type
+#else
   cgal_bgl_named_params
   <typename Kernel_traits<Point>::Kernel,
    internal_np::geom_traits_t,
@@ -846,6 +862,7 @@ public:
     cgal_bgl_named_params
     <typename CGAL::Point_set_3<Point, Vector>::template Property_map<Point>,
      internal_np::point_t> > >
+#endif
   inline parameters() const
   {
     return CGAL::parameters::point_map (m_points).
@@ -1160,7 +1177,7 @@ Point_set_3<Point, Vector>& operator+=(Point_set_3<Point, Vector>& ps,
 
 
 
-
+/// \cond SKIP_IN_MANUAL
 namespace Point_set_processing_3
 {
   namespace parameters
@@ -1181,7 +1198,7 @@ namespace Point_set_processing_3
     }
   }
 }
-
+/// \endcond
 
 } // namespace CGAL