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] 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>