Fixed some methods' documentation

lodel/leapi/datahandlers/base_classes.py

@@ -421,7 +421,7 @@ class MultipleRef(Reference):
         return new_val
 
     ##@brief Utility method designed to fetch referenced objects
-    #@param value mixed : the field value
+    #@param values mixed : the field values
     #@return A list of LeObject child class instance
     #@throw LodelDataHandlerConsistencyException if some referenced objects
     #were not found
@@ -453,7 +453,7 @@ some referenced objects. Followinf uid were not found : %s" % ','.join(left))
 class DatasConstructor(object):
 
     ## @brief Init a DatasConstructor
-    # @param lec LeCrud : @ref LeObject child class
+    # @param leobject LeCrud : @ref LeObject child class
     # @param datas dict : dict with field name as key and field values as value
     # @param fields_handler dict : dict with field name as key and data handler instance as value
     def __init__(self, leobject, datas, fields_handler):

lodel/leapi/datahandlers/datas.py

@@ -21,7 +21,6 @@ build its content'
     
     ##@brief Build its content with a field list and a format string
     # @param format_string str
-    # @param max_length int : the maximum length of the handled value
     # @param field_list list : List of field to use
     # @param **kwargs
     def __init__(self, format_string, field_list, **kwargs):
@@ -115,7 +114,6 @@ class Concat(FormatString):
     
     ##@brief Build its content with a field list and a separator
     # @param field_list list : List of field to use
-    # @param max_length int : the maximum length of the handled value
     # @param separator str
     # @param **kwargs    
     def __init__(self, field_list, separator = ' ', **kwargs):

lodel/leapi/datahandlers/datas_base.py

@@ -44,9 +44,10 @@ class Integer(DataField):
         super().__init__( **kwargs)
 
     ##@brief Check and cast value in appropriate type
-    #@param value *
-    #@throw FieldValidationError if value is unappropriate or can not be cast 
-    #@return value
+    # @param value *
+    # @param strict bool : tells if the value must be an integer or a value that can be converted into an integer
+    # @throw FieldValidationError if value is unappropriate or can not be cast
+    # @return value
     def _check_data_value(self, value, strict = False):
         value = super()._check_data_value(value)
         if (strict and not isinstance(value, int)):

lodel/leapi/datahandlers/references.py

@@ -16,9 +16,11 @@ class Link(SingleRef):
 class List(MultipleRef):
 
     ##@brief instanciates a list reference
-    # @param allowed_classes list | None : list of allowed em classes if None no restriction
-    # @param internal bool
+    # @param max_length int
     # @param kwargs
+    #   - allowed_classes list | None : list of allowed em classes if None no restriction
+    #   - internal bool
+
     def __init__(self, max_length = None, **kwargs):
         super().__init__(**kwargs)
 
@@ -43,9 +45,9 @@ a list : %s" % e)
 class Set(MultipleRef):
 
     ##@brief instanciates a set reference
-    # @param allowed_classes list | None : list of allowed em classes if None no restriction
-    # @param internal bool : if False, the field is not internal
-    # @param kwargs : Other named arguments
+    # @param kwargs : named arguments
+    #   - allowed_classes list | None : list of allowed em classes if None no restriction
+    #   - internal bool : if False, the field is not internal
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
@@ -69,9 +71,9 @@ a set : %s" % e)
 class Map(MultipleRef):
 
     ##@brief instanciates a dict reference
-    # @param allowed_classes list | None : list of allowed em classes if None no restriction
-    # @param internal bool : if False, the field is not internal
-    # @param kwargs : Other named arguments
+    # @param kwargs : named arguments
+    #   - allowed_classes list | None : list of allowed em classes if None no restriction
+    #   - internal bool : if False, the field is not internal
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 

lodel/leapi/lefactory.py

@@ -115,7 +115,6 @@ def forge_optval(optval):
 
 ##@brief Generate dyncode from an EmClass
 # @param model EditorialModel : 
-# @param emclass EmClass : EmClass instance
 # @todo delete imports. It is never use, consequently changed return parameters.
 # @return a tuple with emclass python code, a set containing modules name to import, and a list of python instruction to bootstrap dynamic code, in this order
 def generate_classes(model):

lodel/leapi/lefactory_common.py

@@ -17,7 +17,7 @@ def name2class(name):
 ##@brief Return a dynamically generated class given it's name
 #@note Case insensitive version of name2class
 #@param name str
-#@retrun False or a child class of LeObject
+#@return False or a child class of LeObject
 def lowername2class(name):
     name = name.lower()
     new_dict = {k.lower():v for k,v in dynclasses_dict.items()}

lodel/leapi/leobject.py

@@ -34,6 +34,7 @@ CLASS_ID_FIELDNAME = "classname"
 class LeObjectValues(object):
     
     ##@brief Construct a new LeObjectValues
+    # @param fieldnames_callback method
     # @param set_callback method : The LeObject.set_datas() method of corresponding LeObject class
     # @param get_callback method : The LeObject.get_datas() method of corresponding LeObject class
     def __init__(self, fieldnames_callback, set_callback, get_callback):
@@ -294,7 +295,7 @@ class LeObject(object):
 
     ##@brief Read only access to all datas
     # @note for fancy data accessor use @ref LeObject.g attribute @ref LeObjectValues instance
-    # @param name str : field name
+    # @param field_name str : field name
     # @return the Value
     # @throw RuntimeError if the field is not initialized yet
     # @throw NameError if name is not an existing field name
@@ -516,6 +517,7 @@ construction and consitency when datas are not complete\n")
     # @warning assert that datas is complete
     # @param cls
     # @param datas dict : Datas that have been returned by LeCrud.prepare_datas() method
+    # @param type_query str : Type of query to be performed , default value : insert
     @classmethod
     def make_consistency(cls, datas, type_query = 'insert'):
         for fname, dh in cls._fields.items():
@@ -565,8 +567,8 @@ construction and consitency when datas are not complete\n")
         return result
     
     ## @brief Delete instances of LeObject
-    #@param uids a list: lists of (fieldname, fieldvalue), with fieldname in cls._uids
-    #@returns the 
+    #@param query_filters list
+    #@returns the number of deleted items
     @classmethod
     def delete_bundle(cls, query_filters):
         deleted = 0
@@ -585,7 +587,6 @@ construction and consitency when datas are not complete\n")
             
     ## @brief Get instances of LeObject
     #
-    #@param target_class LeObject : class of object the query is about
     #@param query_filters dict : (filters, relational filters), with filters is a list of tuples : (FIELD, OPERATOR, VALUE) )
     #@param field_list list|None : list of string representing fields see 
     #@ref leobject_filters
@@ -593,7 +594,6 @@ construction and consitency when datas are not complete\n")
     #@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 Inst
     #@return a list of items (lists of (fieldname, fieldvalue))
     @classmethod
     def get(cls, query_filters, field_list=None, order=None, group=None, limit=None, offset=0):

lodel/leapi/query.py

@@ -485,7 +485,7 @@ abstract LeObject : %s" % target_class)
         super().__init__(target_class)
     
     ## @brief Implements an insert query operation, with only one insertion
-    # @param new_datas : datas to be inserted
+    # @param datas : datas to be inserted
     def _query(self, datas):
         datas = self._target_class.prepare_datas(datas, True, False)
         id_inserted = self._rw_datasource.insert(self._target_class, datas)
@@ -544,8 +544,6 @@ target to LeUpdateQuery constructor"
         super().__init__(target_class, query_filters)
 
     ##@brief Implements an update query
-    #@param filters list : see @ref LeFilteredQuery
-    #@param rel_filters list : see @ref LeFilteredQuery
     #@param datas dict : datas to update
     #@returns the number of updated items
     #@todo change stategy for instance update. Datas should be allowed
@@ -599,12 +597,12 @@ class LeDeleteQuery(LeFilteredQuery):
         super().__init__(target_class, query_filter)
 
     ## @brief Execute the delete query
+    # @param datas
     def execute(self, datas=None):
         return super().execute()
 
     ##@brief Implements delete query operations
-    #@param filters list : see @ref LeFilteredQuery
-    #@param rel_filters list : see @ref LeFilteredQuery
+    # @param datas
     #@returns the number of deleted items
     def _query(self, datas=None):
         filters, rel_filters = self._query_filter
@@ -619,12 +617,12 @@ class LeGetQuery(LeFilteredQuery):
     #@param target_class LeObject : class of object the query is about
     #@param query_filters dict : {OP, list of query filters}
     # or tuple (FIELD, OPERATOR, VALUE) )
-    #@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 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 kwargs dict : other query-related arguments and options
+    #   - field_list list|None : list of string representing fields see @ref leobject_filters
+    #   - order list : A list of field names or tuple (FIELDNAME,[ASC | DESC])
+    #   - group list : A list of field names or tuple (FIELDNAME,[ASC | DESC])
+    #   - limit int : The maximum number of returned results
+    #   - offset int : offset
     def __init__(self, target_class, query_filters, **kwargs):
         super().__init__(target_class, query_filters)
         ##@brief The fields to get

lodel/plugin/datasource_plugin.py

@@ -31,7 +31,7 @@ reimplemented by plugin datasource child class")
         self._abs_err()
 
     ##@brief returns a selection of documents from the datasource
-    #@param target_cls Emclass
+    #@param target Emclass
     #@param field_list list
     #@param filters list : List of filters
     #@param rel_filters list : List of relational filters
@@ -231,7 +231,7 @@ but %s is a %s" % (ds_name, pinstance.__class__.__name__))
         return pinstance
 
     ##@brief Return a datasource class given a datasource name
-    #@param ds_name str : datasource plugin name
+    #@param ds_plugin_name str : datasource plugin name
     #@throw PluginError if ds_name is not an existing plugin name
     #@throw PluginTypeError if ds_name is not the name of a DatasourcePlugin
     @classmethod

lodel/plugin/plugins.py

@@ -883,7 +883,6 @@ CustomMethod::STATIC_METHOD, but got %s" % self._type)
     
     ##@brief called just after __init__
     #@param fun function : the decorated function
-    #@param return the function
     def __call__(self, fun):
         if self._method_name is None:
             self._method_name = fun.__name__

lodel/plugin/scripts.py

@@ -81,7 +81,7 @@ class LodelScript(object, metaclass=MetaLodelScript):
         raise NotImplementedError("Static class")
     
     ##@brief Virtual method. Designed to initialize arguement parser.
-    #@param argparser ArgumentParser : Child class argument parser instance
+    #@param parser ArgumentParser : Child class argument parser instance
     #@return MUST return the argument parser (NOT SURE ABOUT THAT !! Maybe it \
     #works by reference)
     @classmethod

lodel/plugins/dummy_datasource/datasource.py

@@ -18,10 +18,10 @@ class DummyDatasource(AbstractDatasource):
         pass
 
     ##@brief returns a selection of documents from the datasource
-    #@param target_cls Emclass
+    #@param target Emclass
     #@param field_list list
     #@param filters list : List of filters
-    #@param rel_filters list : List of relational filters
+    #@param relational_filters list : List of relational filters
     #@param order list : List of column to order. ex: order = [('title', 'ASC'),]
     #@param group list : List of tupple representing the column to group together. ex: group = [('title', 'ASC'),]
     #@param limit int : Number of records to be returned

lodel/settings/settings.py

@@ -80,7 +80,7 @@ class Settings(object, metaclass=MetaSettings):
     
     ## @brief Instanciate the Settings singleton
     # @param conf_dir str : The configuration directory
-    #@param custom_confspec None | dict : if given overwrite default lodel2
+    #@param custom_confspecs None | dict : if given overwrite default lodel2
     #confspecs
     def __init__(self, conf_dir, custom_confspecs = None):
         self.singleton_assert() # check that it is the only instance

lodel/settings/validator.py

@@ -406,7 +406,10 @@ SettingValidator.create_re_validator(
 ##@brief Append a piece of confspec
 #@note orig is modified during the process
 #@param orig dict : the confspec to update
-#@param upd dict : the confspec to add
+#@param section str : section name
+#@param key str
+#@param validator SettingValidator : the validator to use to check this configuration key's value
+#@param default
 #@return new confspec
 def confspec_append(orig, section, key, validator, default):
     if section not in orig:

progs/slim/slim.py

@@ -281,6 +281,7 @@ def get_pid(name):
 
 ##@brief Start an instance
 #@param names list : instance name list
+#@param foreground bool
 def start_instances(names, foreground):
     pids = get_pids()
     store_datas = get_store_datas()