Add documentation for PolyHLRToShape

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.
 

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>