Improve PythonAPI documentstion.

[modules/shaper.git] / src / PythonAPI / model / features / extrusion_boolean.py

diff --git a/src/PythonAPI/model/features/extrusion_boolean.py b/src/PythonAPI/model/features/extrusion_boolean.py
index f7e168fdef15b5fc716fd55a79d1b7377bed0a57..a5b4d1e0937af2995b1760e09e7764f706d8ed4e 100644 (file)
--- a/src/PythonAPI/model/features/extrusion_boolean.py
+++ b/src/PythonAPI/model/features/extrusion_boolean.py
@@ -26,8 +26,37 @@ def addExtrusionFuse(part, *args):
 
 
 class ExtrusionBoolean(CompositeBoolean):
+    """Interface class for ExtrusionBoolean features.
+
+    Supported features:
+    - ExtrusionCut
+    - ExtrusionFuse
+
+    ExtrusionBoolean(feature) -> feature interface without initialization
+    ExtrusionBoolean(feature,
+                     sketch, sketch_selection, boolean_objects,
+                     to_size, from_size) ->
+        feature interface initialized from arguments:
+        - sketch
+        - sketch_selection
+        - boolean_objects
+        - to_size
+        - from_size
+    ExtrusionBoolean(feature,
+                     sketch, sketch_selection, boolean_objects,
+                     to_object, to_offset, from_object, from_offset) ->
+        feature interface initialized from arguments:
+        - sketch
+        - sketch_selection
+        - boolean_objects
+        - to_object
+        - to_offset
+        - from_object
+        - from_offset
+    """
 
     def __init__(self, feature, *args):
+        """x.__init__(...) initializes x; see x.__class__.__doc__ for signature"""
         CompositeBoolean.__init__(self, feature, *args[:3])
         args = args[3:]