Cleanings doxygen comments

EditorialModel/fieldtypes/generic.py

@@ -97,8 +97,9 @@ class SingleValueFieldType(GenericFieldType):
     
     ## @brief Instanciate a new fieldtype
     # @param nullable bool : is None allowed as value ?
-    # @param uniqu bool : Indicate if a field should handle uniq value
+    # @param uniq bool : Indicate if a field should handle uniq value
     # @param primary bool : If True the field is a primary key
+    # @param internal str|False : if False the field is not internal. Else can be 'autosql' or 'internal'
     # @param **args : Other arguments
     # @throw NotImplementedError if called from bad class
     def __init__(self, internal = False, nullable = True, uniq = False, primary = False, **args):
@@ -133,7 +134,7 @@ class ReferenceFieldType(SingleValueFieldType):
     #
     # @param reference str : A string that defines the reference (can be 'object' or 'relation')
     # @param nullable bool : is None allowed as value ?
-    # @param unique bool : Indicate if a field should handle uniq value
+    # @param uniq bool : Indicate if a field should handle uniq value
     # @param primary bool : If True the field is a primary key
     # @param internal str|False : if False the field is not internal. Else can be 'autosql' or 'internal'
     # @param **args : Other arguments

EditorialModel/fieldtypes/join.py

@@ -11,6 +11,7 @@ class EmFieldType(char.EmFieldType):
     # @param field_list list : fieldname list
     # @param glue str : separator
     # @param max_length int : Field max length
+    # @param **kwargs
     def __init__(self, field_list, max_length, glue = ' ', **kwargs):
         self._field_list = field_list
         super().__init__(internal='automatic', max_length = max_length)

EditorialModel/randomem.py

@@ -170,6 +170,7 @@ class RandomEm(object):
 
     @classmethod
     ## @brief Generate a random MlString
+    # @param cls
     # @param nlng : Number of langs in the MlString
     # @return a random MlString with nlng translations
     # @todo use a dict to generated langages

EditorialModel/test/test_field.py

@@ -110,6 +110,6 @@ class TestField(FieldTestCase):
             self.assertNotIn(field, field_components_records)
 
     def test_emclass(self):
-        """ Test if the EmField.em_class @property method is correct """
+        """ Test if the EmField.em_class \@property method is correct """
         for field in EM_TEST_OBJECT.components(EmField):
             self.assertIn(field, field.em_class.fields())

Lodel/settings.py

@@ -14,7 +14,7 @@ from . import settings_format
 #
 # When instanciating a SettingsHandler, the new instance is filled with the content of settings.py (in the root directory of lodel2
 #
-# @important You don't have to instanciate this class, you can access to the global instance with the Settings variable in this module
+# @warning You don't have to instanciate this class, you can access to the global instance with the Settings variable in this module
 # @todo Forbid module assignement in settings ! and disable tests about this
 # @todo Implements a type checking of config value
 # @todo Implements default values for config keys

Lodel/utils/mlstring.py

@@ -11,7 +11,8 @@ class MlString(object):
     default_lang = '___'
     ## Instanciate a new string with translation
     #
-    # @param translations dict: With key = lang and value the translation
+    # @param translations dict|str : With key = lang and value the translation  or a json string
+    # @param default_value str : The default translation value
     def __init__(self, translations=None, default_value = None):
         if isinstance(translations, str):
             try:

leapi/lecrud.py

@@ -16,7 +16,8 @@ REL_SUB = 1
 
 class LeApiErrors(Exception):
     ## @brief Instanciate a new exceptions handling multiple exceptions
-    # @param exptexptions dict : A list of data check Exception with concerned field (or stuff) as key
+    # @param msg str : Exception message
+    # @param exceptions dict : A list of data check Exception with concerned field (or stuff) as key
     def __init__(self, msg = "Unknow error", exceptions = None):
         self._msg = msg
         self._exceptions = dict() if exceptions is None else exceptions
@@ -62,7 +63,7 @@ class _LeCrud(object):
     ## @brief Asbtract constructor for every child classes
     # @param uid int : lodel_id if LeObject, id_relation if its a LeRelation
     # @param **kwargs : datas !
-    # @raise NotImplementedError if trying to instanciate a class that cannot be instanciated
+    # @throw NotImplementedError if trying to instanciate a class that cannot be instanciated
     def __init__(self, uid, **kwargs):
         if len(kwargs) > 0:
             if not self.implements_leobject() and not self.implements_lerelation():
@@ -109,7 +110,9 @@ class _LeCrud(object):
         return name.title()
 
     ## @brief Convert an EmCalss and EmType name in a rel2type class name
-    # @param name str : The name
+    # @param class_name str : The name of concerned class
+    # @param type_name str : The name of the concerned type
+    # @param relation_name str : The name of the relation (the name of the rel2type field in the LeClass)
     # @return name.title()
     @staticmethod
     def name2rel2type(class_name, type_name, relation_name):
@@ -118,6 +121,7 @@ class _LeCrud(object):
 
     ## @brief Given a dynamically generated class name return the corresponding python Class
     # @param name str : a concrete class name
+    # @param cls
     # @return False if no such component
     @classmethod
     def name2class(cls, name):
@@ -299,6 +303,7 @@ class _LeCrud(object):
     # @param datas dict : key == field name value are field values
     # @param complete bool : if True expect that datas provide values for all non internal fields
     # @param allow_internal bool : if True don't raise an error if a field is internal
+    # @param cls
     # @return Checked datas
     # @throw LeApiDataCheckError if errors reported during check
     @classmethod
@@ -344,9 +349,11 @@ class _LeCrud(object):
     # @param query_filters list : list of string of query filters (or tuple (FIELD, OPERATOR, VALUE) ) see @ref leobject_filters
     # @param field_list list|None : list of string representing fields see @ref leobject_filters
     # @param order list : A list of field names or tuple (FIELDNAME, [ASC | DESC])
-    # @param groups list : A list of field names or tuple (FIELDNAME, [ASC | DESC])
+    # @param group list : A list of field names or tuple (FIELDNAME, [ASC | DESC])
     # @param limit int : The maximum number of returned results
     # @param offset int : offset
+    # @param instanciate bool : If True return an instance, else return a dict
+    # @param cls
     # @return A list of lodel editorial components instance
     # @todo think about LeObject and LeClass instanciation (partial instanciation, etc)
     @classmethod
@@ -397,6 +404,8 @@ class _LeCrud(object):
 
     ## @brief Insert a new component
     # @param datas dict : The value of object we want to insert
+    # @param classname str : The class name
+    # @param cls
     # @return A new id if success else False
     @classmethod
     def insert(cls, datas, classname=None):
@@ -415,6 +424,7 @@ class _LeCrud(object):
     # @param datas dict : {fieldname : fieldvalue, ...}
     # @param complete bool : If True you MUST give all the datas
     # @param allow_internal : Wether or not interal fields are expected in datas
+    # @param cls
     # @return Datas ready for use
     # @todo: complete is very unsafe, find a way to get rid of it
     @classmethod
@@ -444,6 +454,7 @@ class _LeCrud(object):
 
     ## @brief Construct datas values
     #
+    # @param cls
     # @param datas dict : Datas that have been returned by LeCrud.check_datas_value() methods
     # @return A new dict of datas
     @classmethod
@@ -459,7 +470,7 @@ class _LeCrud(object):
     ## @brief Check datas consistency
     # 
     # @warning assert that datas is complete
-    #
+    # @param cls
     # @param datas dict : Datas that have been returned by LeCrud._construct_datas() method
     # @throw LeApiDataCheckError if fails
     @classmethod
@@ -476,6 +487,7 @@ class _LeCrud(object):
         
 
     ## @brief Prepare a field_list
+    # @param cls
     # @param field_list list : List of string representing fields
     # @return A well formated field list
     # @throw LeApiDataCheckError if invalid field given
@@ -499,6 +511,7 @@ class _LeCrud(object):
         return ret_field_list
      
     ## @brief Check that a relational field is valid
+    # @param cls
     # @param field str : a relational field
     # @return a nature
     @classmethod
@@ -506,6 +519,8 @@ class _LeCrud(object):
         raise NotImplementedError("Abstract method")
     
     ## @brief Check that the field list only contains fields that are in the current class
+    # @param cls
+    # @param field : a field
     # @return None if no problem, else returns a list of exceptions that occurs during the check
     @classmethod
     def _check_field(cls, field):
@@ -515,7 +530,8 @@ class _LeCrud(object):
     
     ## @brief Prepare the order parameter for the get method
     # @note if an item in order_list is just a str it is considered as ASC by default
-    # @param order_list list : A list of field name or tuple (FIELDNAME, [ASC|DESC])
+    # @param cls
+    # @param order_field_list list : A list of field name or tuple (FIELDNAME, [ASC|DESC])
     # @return a list of tuple (FIELDNAME, [ASC|DESC] )
     @classmethod
     def _prepare_order_fields(cls, order_field_list):
@@ -544,6 +560,7 @@ class _LeCrud(object):
     # 
     # Both categories of filters are represented in the same way, a tuple with 3 elements (NAME|NAT , OP, VALUE )
     # 
+    # @param cls
     # @param filters_l list : This list can contain str "FIELDNAME OP VALUE" and tuples (FIELDNAME, OP, VALUE)
     # @return a tuple(FILTERS, RELATIONNAL_FILTERS
     #

leapi/lerelation.py

@@ -252,6 +252,8 @@ class _LeRel2Type(_LeRelation):
     ## @brief Given a superior and a subordinate, returns the classname of the give rel2type
     # @param lesupclass LeClass : LeClass child class (not an instance) (can be a LeType or a LeClass child)
     # @param lesubclass LeType : A LeType child class (not an instance)
+    # @param relation_name str : Name of the relation (rel2type field name in LeClass)
+    # @param cls
     # @return a name as string
     @classmethod
     def relname(cls, lesupclass, lesubclass, relation_name):

leapi/letype.py

@@ -69,7 +69,7 @@ class _LeType(_LeClass):
         return self.datas()
     
     ## @brief Add a superior
-    # @param lesup LeObject : LeObject child class instance
+    # @param superior LeObject : LeObject child class instance
     # @param nature str : Relation nature
     # @param del_if_exists bool : If true delete the superior if any before setting the new one
     # @return relation id if successfully created else returns false

leapi/test/test_letype.py

@@ -48,7 +48,7 @@ class LeTypeTestCase(TestCase):
     
     @patch('leapi.letype._LeType.populate')
     def test_datas(self, dsmock):
-        """ Testing the datas @property method """
+        """ Testing the datas \@property method """
         from dyncode import Publication, Numero, LeObject
         num = Numero(42, titre = 'foofoo')
         self.assertEqual({'lodel_id' : 42, 'titre': 'foofoo'}, num.datas())