]> SALOME platform Git repositories - plugins/dxfplugin.git/blobdiff - src/DXFPluginBuilder.py
Salome HOME
Merge from rnv/geom_plugin_imp branch
[plugins/dxfplugin.git] / src / DXFPluginBuilder.py
index 63404d6b7c1019b0c7d4ef61169d94703610cb04..ff92dd7197bbe2fe908d0134805dc06a57397442 100644 (file)
@@ -1,5 +1,5 @@
 #  -*- coding: iso-8859-1 -*-
-# Copyright (C) 2014  CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2014-2015  OPEN CASCADE
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -23,13 +23,22 @@ from DXFPlugin import IDXFOperations
 # Engine Library Name
 __libraryName__ = "DXFPluginEngine"
 
+## Get DXF plugin operations interface
+#  @return an instance of DXF plugin operations interface
 def GetDXFPluginOperations(self):
+    """
+    Get DXF plugin operations interface.
+
+    Returns:
+        An instance of DXF plugin operations interface
+    """
     anOp = self.GetPluginOperations(self.myStudyId, __libraryName__)
     return anOp._narrow(IDXFOperations)
 
 ## Export the given shape into a file with given name in DXF format.
 #  @param theObject Shape to be stored in the file.
 #  @param theFileName Name of the file to store the given shape in.
+#  @sa ImportDXF
 def ExportDXF(self, theObject, theFileName):
     """
     Export the given shape into a file with given name in DXF format.
@@ -56,8 +65,11 @@ def ExportDXF(self, theObject, theFileName):
 #          If material names are imported it returns the list of
 #          objects. The first one is the imported object followed by
 #          material groups.
+#
 #  @note Auto publishing is allowed for the shape itself. Imported
 #        material groups are not automatically published.
+#
+#  @sa ExportDXF
 def ImportDXF(self, theFileName, theName=None):
     """
     Import a shape from the DXF file