From 6d6f8ca1e0d2a0775586adf6623e7b466aadfff9 Mon Sep 17 00:00:00 2001
From: Rohan Mishra <315scisyb2020rohanmishra@gmail.com>
Date: Mon, 30 Oct 2023 20:40:29 +0530
Subject: [PATCH 01/10] Update HLRBRep_AlgoPy.xml

#10728

Updated the API documentation of HLRBRep_AlgoPy.xml.
---
 src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml | 36 ++++++++++++---------
 1 file changed, 21 insertions(+), 15 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
index 167dff70d3..657c802bc1 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
@@ -18,89 +18,95 @@
     </Documentation>
     <Methode Name="add">
         <Documentation>
-            <UserDocu>
+            <UserDocu>Adds the shape S to this framework, and
+  specifies the number of isoparameters nbiso desired in visualizing S.
+  You may add as many shapes as you wish. Use the function Add once for each shape.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="remove">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>Remove the shape S from this framework.</UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="index">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>return  the index  of  the  Shape <S>  and
+  return 0 if the Shape <S> is not found.</UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLinedShapeNullify">
         <Documentation>
-            <UserDocu>
+            <UserDocu> Nullify all the results of OutLiner from HLRTopoBRep.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="setProjector" Keyword="true">
         <Documentation>
-            <UserDocu>
+            <UserDocu>set the projector.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nbShapes">
         <Documentation>
-            <UserDocu>
+            <UserDocu>This function is a const member function that returns the number of shapes in the collection.
+                It does not modify the object's state and is used to retrieve the count of shapes.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="showAll">
         <Documentation>
-            <UserDocu>
+            <UserDocu> set to visible all the edges.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hide">
         <Documentation>
-            <UserDocu>
+            <UserDocu>hide the Shape <S> by itself.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hideAll">
         <Documentation>
-            <UserDocu>
+            <UserDocu>set to  hide all the  edges of the  Shape <S>.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="partialHide">
         <Documentation>
-            <UserDocu>
+            <UserDocu>own hiding  of all the shapes of the DataStructure
+  without hiding by each other.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="select">
         <Documentation>
-            <UserDocu>
+            <UserDocu>select all the DataStructure.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="selectEdge">
         <Documentation>
-            <UserDocu>
+            <UserDocu>select only the edges of the Shape <S>
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="selectFace">
         <Documentation>
-            <UserDocu>
+            <UserDocu>select only the faces of the Shape <S>.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="initEdgeStatus">
         <Documentation>
-            <UserDocu>
+            <UserDocu>init the status of the selected edges depending of
+  the back faces of a closed shell.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="update">
         <Documentation>
-            <UserDocu>
+            <UserDocu>update the DataStructure.
             </UserDocu>
         </Documentation>
     </Methode>

From 75e18e3cf9167ffd5004dc373ae3d865720f4f2e Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Tue, 14 Nov 2023 15:13:48 +0100
Subject: [PATCH 02/10] Change <S> to S

Otherwise, it is invalid XML
---
 src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
index 657c802bc1..ec0bb0238f 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
@@ -31,8 +31,8 @@
     </Methode>
     <Methode Name="index">
         <Documentation>
-            <UserDocu>return  the index  of  the  Shape <S>  and
-  return 0 if the Shape <S> is not found.</UserDocu>
+            <UserDocu>return  the index  of  the  Shape S  and
+  return 0 if the Shape S is not found.</UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLinedShapeNullify">
@@ -62,13 +62,13 @@
     </Methode>
     <Methode Name="hide">
         <Documentation>
-            <UserDocu>hide the Shape <S> by itself.
+            <UserDocu>hide the Shape S by itself.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hideAll">
         <Documentation>
-            <UserDocu>set to  hide all the  edges of the  Shape <S>.
+            <UserDocu>set to  hide all the  edges of the  Shape S.
             </UserDocu>
         </Documentation>
     </Methode>
@@ -87,13 +87,13 @@
     </Methode>
     <Methode Name="selectEdge">
         <Documentation>
-            <UserDocu>select only the edges of the Shape <S>
+            <UserDocu>select only the edges of the Shape S
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="selectFace">
         <Documentation>
-            <UserDocu>select only the faces of the Shape <S>.
+            <UserDocu>select only the faces of the Shape S.
             </UserDocu>
         </Documentation>
     </Methode>

From ca159ae8478cf20dfe5a0d7c0d677af11b08b833 Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Tue, 14 Nov 2023 17:02:34 +0100
Subject: [PATCH 03/10] Improve the documentation of HLRBRep.Algo

---
 src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml | 115 ++++++++++++++++----
 1 file changed, 93 insertions(+), 22 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
index ec0bb0238f..c3df82e957 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
@@ -14,99 +14,170 @@
       Delete="false">
     <Documentation>
           <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
-          <UserDocu>Describes functions to use HLR algorithm.</UserDocu>
+          <UserDocu>A framework to compute a shape as seen in a projection
+plane. This is done by calculating the visible and the hidden parts
+of the shape. HLRBRep_Algo works with three types of entity:
+
+- shapes to be visualized
+- edges in these shapes (these edges are the basic entities which will be
+  visualized or hidden), and
+- faces in these shapes which hide the edges.
+
+HLRBRep_Algo is based on the principle of comparing each edge of the shape to
+be visualized with each of its faces, and calculating the visible and the
+hidden parts of each edge. For a given projection, HLRBRep_Algo calculates a
+set of lines characteristic of the object being represented. It is also used in
+conjunction with the HLRBRep_HLRToShape extraction utilities, which reconstruct
+a new, simplified shape from a selection of calculation results. This new shape
+is made up of edges, which represent the shape visualized in the
+projection. HLRBRep_Algo takes the shape itself into account whereas
+HLRBRep_PolyAlgo works with a polyhedral simplification of the shape. When you
+use HLRBRep_Algo, you obtain an exact result, whereas, when you use
+HLRBRep_PolyAlgo, you reduce computation time but obtain polygonal segments. In
+the case of complicated shapes, HLRBRep_Algo may be time-consuming. An
+HLRBRep_Algo object provides a framework for:
+
+- defining the point of view
+- identifying the shape or shapes to be visualized
+- calculating the outlines
+- calculating the visible and hidden lines of the shape. Warning
+- Superimposed lines are not eliminated by this algorithm.
+- There must be no unfinished objects inside the shape you wish to visualize.
+- Points are not treated.
+- Note that this is not the sort of algorithm used in generating shading, which
+  calculates the visible and hidden parts of each face in a shape to be
+  visualized by comparing each face in the shape with every other face in the
+  same shape.
+
+	  </UserDocu>
     </Documentation>
     <Methode Name="add">
         <Documentation>
-            <UserDocu>Adds the shape S to this framework, and
-  specifies the number of isoparameters nbiso desired in visualizing S.
-  You may add as many shapes as you wish. Use the function Add once for each shape.
+            <UserDocu>add(S, nbIso=0)
+
+Adds the shape S to this framework, and specifies the number of isoparameters
+nbiso desired in visualizing S.  You may add as many shapes as you wish.  Use
+the function add once for each shape.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="remove">
         <Documentation>
-            <UserDocu>Remove the shape S from this framework.</UserDocu>
+            <UserDocu>remove(i)
+
+Remove the shape of index i from this framework.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="index">
         <Documentation>
-            <UserDocu>return  the index  of  the  Shape S  and
-  return 0 if the Shape S is not found.</UserDocu>
+            <UserDocu>index(S) ->  int
+
+Return the index of the Shape S and return 0 if the Shape S is not found.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLinedShapeNullify">
         <Documentation>
-            <UserDocu> Nullify all the results of OutLiner from HLRTopoBRep.
+            <UserDocu>outlinedShapeNullify()
+
+Nullify all the results of OutLiner from HLRTopoBRep.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="setProjector" Keyword="true">
         <Documentation>
-            <UserDocu>set the projector.
+            <UserDocu>setProjector(Origin=(0, 0, 0), ZDir=(0,0,0), XDir=(0,0,0), focus=NaN)
+
+Set the projector.  With focus left to NaN, an axonometric projector is
+created.  Otherwise, a perspective projector is created with focus focus.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nbShapes">
         <Documentation>
-            <UserDocu>This function is a const member function that returns the number of shapes in the collection.
-                It does not modify the object's state and is used to retrieve the count of shapes.
+            <UserDocu>nbShapes()
+
+Returns the number of shapes in the collection.  It does not modify the
+object's state and is used to retrieve the count of shapes.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="showAll">
         <Documentation>
-            <UserDocu> set to visible all the edges.
+            <UserDocu>showAll(i=-1)
+
+If i &lt; 1, then set all the edges to visible.
+Otherwise, set to visible all the edges of the shape of index i.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hide">
         <Documentation>
-            <UserDocu>hide the Shape S by itself.
+            <UserDocu>hide(i=-1, j=-1)
+
+If i &lt; 1, hide all of the datastructure.
+Otherwise, if j &lt; 1, hide the shape of index i.
+Otherwise, hide the shape of index i by the shape of index j.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hideAll">
         <Documentation>
-            <UserDocu>set to  hide all the  edges of the  Shape S.
+            <UserDocu>hideAll(i=-1)
+
+If i &lt; 1, hide all the edges.
+Otherwise, hide all the edges of shape of index i.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="partialHide">
         <Documentation>
-            <UserDocu>own hiding  of all the shapes of the DataStructure
-  without hiding by each other.
+            <UserDocu>partialHide()
+
+Own hiding of all the shapes of the DataStructure without hiding by each other.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="select">
         <Documentation>
-            <UserDocu>select all the DataStructure.
+            <UserDocu>select(i=-1)
+
+If i &lt; 1, select all the DataStructure.
+Otherwise, only select the shape of index i.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="selectEdge">
         <Documentation>
-            <UserDocu>select only the edges of the Shape S
+            <UserDocu>selectEdge(i)
+
+Select only the edges of the shape of index i.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="selectFace">
         <Documentation>
-            <UserDocu>select only the faces of the Shape S.
+            <UserDocu>selectFace(i)
+		
+Select only the faces of the shape of index i.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="initEdgeStatus">
         <Documentation>
-            <UserDocu>init the status of the selected edges depending of
-  the back faces of a closed shell.
+            <UserDocu>initEdgeStatus()
+
+Init the status of the selected edges depending of the back faces of a closed
+shell.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="update">
         <Documentation>
-            <UserDocu>update the DataStructure.
+            <UserDocu>update()
+		
+Update the DataStructure.
             </UserDocu>
         </Documentation>
     </Methode>

From f97906c4e3d369071aef5874fcc498fc9c8564ad Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Tue, 14 Nov 2023 18:07:43 +0100
Subject: [PATCH 04/10] Add documentation for HLRBRep.PolyAlgo

---
 .../Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml   | 98 +++++++++++++++----
 1 file changed, 79 insertions(+), 19 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
index b2f219652c..828b24cebf 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
@@ -14,103 +14,163 @@
       Delete="false">
     <Documentation>
           <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
-          <UserDocu>Describes functions to use HLR algorithm.</UserDocu>
+          <UserDocu>A framework to compute the shape as seen in a projection
+plane. This is done by calculating the visible and the hidden parts of the
+shape. HLRBRep_PolyAlgo works with three types of entity:
+
+- shapes to be visualized (these shapes must have already been triangulated.)
+- edges in these shapes (these edges are defined as polygonal lines on the
+  triangulation of the shape, and are the basic entities which will be visualized
+  or hidden), and
+- triangles in these shapes which hide the edges.
+
+HLRBRep_PolyAlgo is based on the principle of comparing each edge of the shape
+to be visualized with each of the triangles produced by the triangulation of
+the shape, and calculating the visible and the hidden parts of each edge. For a
+given projection, HLRBRep_PolyAlgo calculates a set of lines characteristic of
+the object being represented. It is also used in conjunction with the
+HLRBRep_PolyHLRToShape extraction utilities, which reconstruct a new,
+simplified shape from a selection of calculation results. This new shape is
+made up of edges, which represent the shape visualized in the
+projection. HLRBRep_PolyAlgo works with a polyhedral simplification of the
+shape whereas HLRBRep_Algo takes the shape itself into account. When you use
+HLRBRep_Algo, you obtain an exact result, whereas, when you use
+HLRBRep_PolyAlgo, you reduce computation time but obtain polygonal segments. An
+HLRBRep_PolyAlgo object provides a framework for:
+
+- defining the point of view
+- identifying the shape or shapes to be visualized
+- calculating the outlines
+- calculating the visible and hidden lines of the shape. Warning
+- Superimposed lines are not eliminated by this algorithm.
+- There must be no unfinished objects inside the shape you wish to visualize.
+- Points are not treated.
+- Note that this is not the sort of algorithm used in generating shading, which
+  calculates the visible and hidden parts of each face in a shape to be
+  visualized by comparing each face in the shape with every other face in the
+  same shape.
+
+	  </UserDocu>
     </Documentation>
     <Methode Name="load">
         <Documentation>
-            <UserDocu>
+            <UserDocu>load(S)
+
+Loads the shape S into this framework. Warning S must have already been triangulated.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="remove">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>remove(i)
+
+Remove the shape of index i from this framework.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nbShapes">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>nbShapes()
+
+Returns the number of shapes in the collection.  It does not modify the
+object's state and is used to retrieve the count of shapes.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="shape">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>shape(i) -> TopoShape
+
+Return the shape of index i.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="index">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>index(S) ->  int
+
+Return the index of the Shape S.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="setProjector" Keyword="true">
         <Documentation>
-            <UserDocu>
+            <UserDocu>setProjector(Origin=(0, 0, 0), ZDir=(0,0,0), XDir=(0,0,0), focus=NaN)
+
+Set the projector.  With focus left to NaN, an axonometric projector is
+created.  Otherwise, a perspective projector is created with focus focus.
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="update">
         <Documentation>
-            <UserDocu>
-            </UserDocu>
+            <UserDocu>update()
+
+Launches calculation of outlines of the shape visualized by this
+framework. Used after setting the point of view and defining the shape or
+shapes to be visualized.
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="initHide">
         <Documentation>
-            <UserDocu>
+            <UserDocu>initHide()<!-- no further documentation available -->
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="moreHide">
         <Documentation>
-            <UserDocu>
+            <UserDocu>moreHide()<!-- no further documentation available -->
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nextHide">
         <Documentation>
-            <UserDocu>
+            <UserDocu>nextHide()<!-- no further documentation available -->
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="initShow">
         <Documentation>
-            <UserDocu>
+            <UserDocu>initShow()<!-- no further documentation available -->
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="moreShow">
         <Documentation>
-            <UserDocu>
+            <UserDocu>moreShow()<!-- no further documentation available -->
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nextShow">
         <Documentation>
-            <UserDocu>
+            <UserDocu>nextShow()<!-- no further documentation available -->
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLinedShape">
         <Documentation>
-            <UserDocu>
+            <UserDocu>outLinedShape(S) -> TopoShape
+
+Make a shape with the internal outlines in each face of shape S.
             </UserDocu>
         </Documentation>
     </Methode>
     <Attribute Name="Angle">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu><!-- no documentation available --></UserDocu>
         </Documentation>
         <Parameter Name="Angle" Type="Float"/>
     </Attribute>
     <Attribute Name="TolAngular">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu><!-- no documentation available --></UserDocu>
         </Documentation>
         <Parameter Name="TolAngular" Type="Float"/>
     </Attribute>
     <Attribute Name="TolCoef">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu><!-- no documentation available --></UserDocu>
         </Documentation>
         <Parameter Name="TolCoef" Type="Float"/>
     </Attribute>

From bb77c0670a5c2c238da3a2dadc5894519f9ec335 Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Tue, 14 Nov 2023 18:08:04 +0100
Subject: [PATCH 05/10] Fix a small problem with parameters

This is the same problem as in https://github.com/FreeCAD/FreeCAD/pull/10727.
Apparently it was also present in PolyAlgo.
---
 src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPyImp.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPyImp.cpp b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPyImp.cpp
index 0082278620..a599d7d1ba 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPyImp.cpp
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPyImp.cpp
@@ -86,7 +86,7 @@ PyObject* HLRBRep_PolyAlgoPy::setProjector(PyObject *args, PyObject *kwds)
     PyObject* xd = nullptr;
     double focus = std::numeric_limits<double>::quiet_NaN();
 
-    static const std::array<const char *, 4> kwlist {"Origin", "ZDir", "XDir", nullptr};
+    static const std::array<const char *, 5> kwlist {"Origin", "ZDir", "XDir", "focus", nullptr};
     if (Base::Wrapped_ParseTupleAndKeywords(args, kwds, "|O!O!O!d", kwlist,
                                             &Base::VectorPy::Type, &ps,
                                             &Base::VectorPy::Type, &zd,

From dc939f519a5979d3a374bf2f639681bcfbfc105b Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Wed, 15 Nov 2023 09:12:38 +0100
Subject: [PATCH 06/10] Remove comments from the text field

---
 .../Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml   | 36 +++++++++----------
 1 file changed, 18 insertions(+), 18 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
index 828b24cebf..5c69dc0ff1 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
@@ -113,38 +113,38 @@ shapes to be visualized.
         </Documentation>
     </Methode>
     <Methode Name="initHide">
-        <Documentation>
-            <UserDocu>initHide()<!-- no further documentation available -->
+        <Documentation><!-- no further documentation available -->
+            <UserDocu>initHide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="moreHide">
-        <Documentation>
-            <UserDocu>moreHide()<!-- no further documentation available -->
+        <Documentation><!-- no further documentation available -->
+            <UserDocu>moreHide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nextHide">
-        <Documentation>
-            <UserDocu>nextHide()<!-- no further documentation available -->
+        <Documentation><!-- no further documentation available -->
+            <UserDocu>nextHide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="initShow">
-        <Documentation>
-            <UserDocu>initShow()<!-- no further documentation available -->
+        <Documentation><!-- no further documentation available -->
+            <UserDocu>initShow()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="moreShow">
-        <Documentation>
-            <UserDocu>moreShow()<!-- no further documentation available -->
+        <Documentation><!-- no further documentation available -->
+            <UserDocu>moreShow()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nextShow">
-        <Documentation>
-            <UserDocu>nextShow()<!-- no further documentation available -->
+        <Documentation><!-- no further documentation available -->
+            <UserDocu>nextShow()
             </UserDocu>
         </Documentation>
     </Methode>
@@ -157,20 +157,20 @@ Make a shape with the internal outlines in each face of shape S.
         </Documentation>
     </Methode>
     <Attribute Name="Angle">
-        <Documentation>
-            <UserDocu><!-- no documentation available --></UserDocu>
+        <Documentation><!-- no documentation available -->
+            <UserDocu></UserDocu>
         </Documentation>
         <Parameter Name="Angle" Type="Float"/>
     </Attribute>
     <Attribute Name="TolAngular">
-        <Documentation>
-            <UserDocu><!-- no documentation available --></UserDocu>
+        <Documentation><!-- no documentation available -->
+            <UserDocu></UserDocu>
         </Documentation>
         <Parameter Name="TolAngular" Type="Float"/>
     </Attribute>
     <Attribute Name="TolCoef">
-        <Documentation>
-            <UserDocu><!-- no documentation available --></UserDocu>
+        <Documentation><!-- no documentation available -->
+            <UserDocu></UserDocu>
         </Documentation>
         <Parameter Name="TolCoef" Type="Float"/>
     </Attribute>

From 572b54976c03064115c9255dfa774d4ce2c13f40 Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Wed, 15 Nov 2023 10:04:10 +0100
Subject: [PATCH 07/10] Add documentation for HLRToShape

---
 src/Mod/Part/App/HLRBRep/HLRToShapePy.xml | 91 +++++++++++++++++++----
 1 file changed, 78 insertions(+), 13 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml b/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml
index 4be1afc6c6..588e436366 100644
--- a/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml
@@ -14,75 +14,140 @@
       Delete="true">
     <Documentation>
           <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
-          <UserDocu>Describes functions to use HLR algorithm.</UserDocu>
+          <UserDocu>HLRToShape(algo: HLRBRep_Algo) -> HLRBRep_HLRToShape
+
+A framework for filtering the computation results of an HLRBRep_Algo algorithm
+by extraction. From the results calculated by the algorithm on a shape, a
+filter returns the type of edge you want to identify. You can choose any of the
+following types of output:
+- visible sharp edges
+- hidden sharp edges
+- visible smooth edges
+- hidden smooth edges
+- visible sewn edges
+- hidden sewn edges
+- visible outline edges
+- hidden outline edges.
+- visible isoparameters and
+- hidden isoparameters.
+
+Sharp edges present a C0 continuity (non G1). Smooth edges present a G1
+continuity (non G2). Sewn edges present a C2 continuity. The result is composed
+of 2D edges in the projection plane of the view which the algorithm has worked
+with. These 2D edges are not included in the data structure of the visualized
+shape. In order to obtain a complete image, you must combine the shapes given
+by each of the chosen filters. The construction of the shape does not call a
+new computation of the algorithm, but only reads its internal results. The
+methods of this shape are almost identic to those of the HLRBrep_PolyHLRToShape
+class.
+	  </UserDocu>
     </Documentation>
     <Methode Name="vCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>vCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible sharp edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="Rg1LineVCompound">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>Rg1LineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible smooth edges for either shape Shape or
+for all added shapes (Shape=None).
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="RgNLineVCompound">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>RgNLineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible sewn edges for either shape Shape or for
+all added shapes (Shape=None).
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLineVCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>outLineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible outline edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLineVCompound3d">
         <Documentation>
-            <UserDocu>
+            <UserDocu>outLineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible outline edges in 3D for either shape
+Shape or for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="isoLineVCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>isoLineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible isoparameters for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>hCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden sharp edges for either shape Shape or for
+all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="Rg1LineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>Rg1LineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden smooth edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="RgNLineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>RgNLineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden sewn edges for either shape Shape or for
+all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>outLineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden outline edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="isoLineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>isoLineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden isoparameters for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="compoundOfEdges" Keyword="true">
         <Documentation>
-            <UserDocu>
+            <UserDocu>compoundOfEdges(Type: int, Visible: bool, In3D: bool, Shape=None) -> TopoShape
+
+Returns compound of resulting edges of required type and visibility, taking
+into account the kind of space (2d or 3d).  If Shape=None, return it for all
+added shapes, otherwise return it for shape Shape.
             </UserDocu>
         </Documentation>
     </Methode>

From f65ec3a00d5a1404d2cdb0b67b74e28a4f177456 Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Wed, 15 Nov 2023 10:08:20 +0100
Subject: [PATCH 08/10] Add constructor documentation as well

---
 src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml     | 5 +++--
 src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml | 4 +++-
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
index c3df82e957..22f810bfa4 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
@@ -14,7 +14,9 @@
       Delete="false">
     <Documentation>
           <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
-          <UserDocu>A framework to compute a shape as seen in a projection
+          <UserDocu>Algo() -> HLRBRep_Algo
+
+A framework to compute a shape as seen in a projection
 plane. This is done by calculating the visible and the hidden parts
 of the shape. HLRBRep_Algo works with three types of entity:
 
@@ -48,7 +50,6 @@ HLRBRep_Algo object provides a framework for:
   calculates the visible and hidden parts of each face in a shape to be
   visualized by comparing each face in the shape with every other face in the
   same shape.
-
 	  </UserDocu>
     </Documentation>
     <Methode Name="add">
diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
index 5c69dc0ff1..10c79c147a 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
@@ -14,7 +14,9 @@
       Delete="false">
     <Documentation>
           <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
-          <UserDocu>A framework to compute the shape as seen in a projection
+          <UserDocu>PolyAlgo() -> HLRBRep_PolyAlgo
+
+A framework to compute the shape as seen in a projection
 plane. This is done by calculating the visible and the hidden parts of the
 shape. HLRBRep_PolyAlgo works with three types of entity:
 

From d40404744bd8ab3288a9dbb291c6d0fbe216792c Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Wed, 15 Nov 2023 10:19:34 +0100
Subject: [PATCH 09/10] Add documentation for PolyHLRToShape

---
 src/Mod/Part/App/HLRBRep/HLRToShapePy.xml     |  2 +-
 src/Mod/Part/App/HLRBRep/PolyHLRToShapePy.xml | 80 +++++++++++++++----
 2 files changed, 66 insertions(+), 16 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml b/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml
index 588e436366..994d0084d0 100644
--- a/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRToShapePy.xml
@@ -27,7 +27,7 @@ following types of output:
 - visible sewn edges
 - hidden sewn edges
 - visible outline edges
-- hidden outline edges.
+- hidden outline edges
 - visible isoparameters and
 - hidden isoparameters.
 
diff --git a/src/Mod/Part/App/HLRBRep/PolyHLRToShapePy.xml b/src/Mod/Part/App/HLRBRep/PolyHLRToShapePy.xml
index b6b61572a4..021f71e5a3 100644
--- a/src/Mod/Part/App/HLRBRep/PolyHLRToShapePy.xml
+++ b/src/Mod/Part/App/HLRBRep/PolyHLRToShapePy.xml
@@ -14,69 +14,119 @@
       Delete="true">
     <Documentation>
           <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
-          <UserDocu>Describes functions to use HLR algorithm.</UserDocu>
+          <UserDocu>PolyHLRToShape(algo: HLRBRep_PolyAlgo) -> HLRBRep_PolyHLRToShape
+
+A framework for filtering the computation results of an HLRBRep_PolyAlgo
+algorithm by extraction.  From the results calculated by the algorithm on a
+shape, a filter returns the type of edge you want to identify.  You can choose
+any of the following types of output:
+- visible sharp edges
+- hidden sharp edges
+- visible smooth edges
+- hidden smooth edges
+- visible sewn edges
+- hidden sewn edges
+- visible outline edges
+- hidden outline edges
+- visible isoparameters and
+- hidden isoparameters.
+
+Sharp edges present a C0 continuity (non G1). Smooth edges present a G1
+continuity (non G2). Sewn edges present a C2 continuity. The result is composed
+of 2D edges in the projection plane of the view which the algorithm has worked
+with. These 2D edges are not included in the data structure of the visualized
+shape. In order to obtain a complete image, you must combine the shapes given
+by each of the chosen filters. The construction of the shape does not call a
+new computation of the algorithm, but only reads its internal results.
+	  </UserDocu>
     </Documentation>
     <Methode Name="update">
-        <Documentation>
-            <UserDocu>
+        <Documentation><!-- OCCT has no further documentation -->
+            <UserDocu>update(algo: HLRBRep_PolyAlgo)
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="show">
-        <Documentation>
-            <UserDocu>
+        <Documentation><!-- OCCT has no further documentation -->
+            <UserDocu>show()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hide">
-        <Documentation>
-            <UserDocu>
+        <Documentation><!-- OCCT has no further documentation -->
+            <UserDocu>hide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="vCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>vCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible sharp edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="Rg1LineVCompound">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>Rg1LineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible smooth edges for either shape Shape or
+for all added shapes (Shape=None).
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="RgNLineVCompound">
         <Documentation>
-            <UserDocu></UserDocu>
+            <UserDocu>RgNLineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible sewn edges for either shape Shape or for
+all added shapes (Shape=None).
+	    </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLineVCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>outLineVCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for visible outline edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="hCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>hCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden sharp edges for either shape Shape or for
+all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="Rg1LineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>Rg1LineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden smooth edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="RgNLineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>RgNLineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden sewn edges for either shape Shape or for
+all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="outLineHCompound">
         <Documentation>
-            <UserDocu>
+            <UserDocu>outLineHCompound(Shape=None) -> TopoShape
+
+Sets the extraction filter for hidden outline edges for either shape Shape or
+for all added shapes (Shape=None).
             </UserDocu>
         </Documentation>
     </Methode>

From bfc418bbf2f924cb74663d8428ebc82b06522078 Mon Sep 17 00:00:00 2001
From: Pieter Hijma <pieterhijma@users.noreply.github.com>
Date: Wed, 15 Nov 2023 10:38:05 +0100
Subject: [PATCH 10/10] Make comments consistent

---
 .../Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml    | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
index 10c79c147a..36527f8c7c 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
@@ -115,37 +115,37 @@ shapes to be visualized.
         </Documentation>
     </Methode>
     <Methode Name="initHide">
-        <Documentation><!-- no further documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu>initHide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="moreHide">
-        <Documentation><!-- no further documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu>moreHide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nextHide">
-        <Documentation><!-- no further documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu>nextHide()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="initShow">
-        <Documentation><!-- no further documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu>initShow()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="moreShow">
-        <Documentation><!-- no further documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu>moreShow()
             </UserDocu>
         </Documentation>
     </Methode>
     <Methode Name="nextShow">
-        <Documentation><!-- no further documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu>nextShow()
             </UserDocu>
         </Documentation>
@@ -159,19 +159,19 @@ Make a shape with the internal outlines in each face of shape S.
         </Documentation>
     </Methode>
     <Attribute Name="Angle">
-        <Documentation><!-- no documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu></UserDocu>
         </Documentation>
         <Parameter Name="Angle" Type="Float"/>
     </Attribute>
     <Attribute Name="TolAngular">
-        <Documentation><!-- no documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu></UserDocu>
         </Documentation>
         <Parameter Name="TolAngular" Type="Float"/>
     </Attribute>
     <Attribute Name="TolCoef">
-        <Documentation><!-- no documentation available -->
+        <Documentation><!-- OCCT has no further documentation -->
             <UserDocu></UserDocu>
         </Documentation>
         <Parameter Name="TolCoef" Type="Float"/>