From: caremoli <caremoli>
Date: Mon, 29 Mar 2010 15:22:39 +0000 (+0000)
Subject: CCAR: add comment for add_type function
X-Git-Tag: V5_1_4a1~3
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=df3d10c14d7f15980bb762e84bf4a23bca4984e9;p=tools%2Fyacsgen.git

CCAR: add comment for add_type function
---

diff --git a/module_generator/yacstypes.py b/module_generator/yacstypes.py
index cef9507..fc2f01a 100644
--- a/module_generator/yacstypes.py
+++ b/module_generator/yacstypes.py
@@ -32,6 +32,19 @@ ValidTypes = corbaTypes.keys()
 PyValidTypes = ValidTypes+["pyobj"]
 
 def add_type(typename, corbaType, corbaOutType, module, idltype):
+  """ add a data type YACS from other module than KERNEL to the list of available types
+
+       :param typename: YACS data type name
+       :type typename: string
+       :param corbaType: representation for C++ CORBA in parameter
+       :type corbaType: string
+       :param corbaOutType: representation for C++ CORBA out parameter
+       :type corbaOutType: string
+       :param module: name of the module that defines the data type (GEOM for GEOM_Object)
+       :type module: string
+       :param idltype: representation for CORBA idl
+       :type idltype: string
+  """
   corbaTypes[typename] = corbaType
   corbaOutTypes[typename] = corbaOutType
   moduleTypes[typename] = module