Documentation on the lodel.plugins.dummy package

lodel/plugins/dummy/__init__.py

@@ -1,20 +1,29 @@
+## @package lodel.plugins.dummy Basic plugin used as a template for developping new plugins
+
 from lodel.context import LodelContext
 LodelContext.expose_modules(globals(), {
     'lodel.validator.validator': ['Validator']})
 
+## @brief plugin's name (matching the package's name)
 __plugin_name__ = "dummy"
+## @brief plugin's version
 __version__ = '0.0.1' #or __version__ = [0,0,1]
+## @brief plugin's loader module
 __loader__ = "main.py"
+## @brief plugin's options' definition module
 __confspec__ = "confspec.py"
+## @brief plugin's author(s)
 __author__ = "Lodel2 dev team"
+## @brief plugin's full name
 __fullname__ = "Dummy plugin"
 __name__ = 'dummy'
+## @brief plugin's category
 __plugin_type__ = 'extension'
 
 
-##@brief This methods allow plugin writter to write some checks
+## @brief This methods allow plugin writter to write some checks
 #
-#@return True if checks are OK else return a string with a reason
+# @return bool : True if checks are OK else return a string with a reason
 def _activate():
     import leapi_dyncode
     print("Testing dynamic objects : ")

lodel/plugins/dummy/confspec.py

@@ -1,9 +1,12 @@
 #-*- coding: utf-8 -*-
 
+## @package lodel.plugins.dummy.confspec The module that defines the plugin's configuration options
+
 from lodel.context import LodelContext
 LodelContext.expose_modules(globals(), {
     'lodel.validator.validator': ['Validator']})
 
+## @brief Dictionary defining the plugin's configuration options and their validators
 CONFSPEC = {
     'lodel2.section1': {
         'key1': (   None,

lodel/plugins/dummy/main.py

@@ -1,10 +1,18 @@
 #-*- coding: utf-8 -*-
 
+## @package lodel.plugins.dummy.main Plugin's loader module
+
 from lodel.context import LodelContext
 LodelContext.expose_modules(globals(), {
     'lodel.plugin': ['LodelHook', 'CustomMethod'],
     'lodel.settings' : 'settings'})
 
+
+## @brief callback method using lodel's hook system
+# @param hook_name str
+# @param caller function : action to perform
+# @param payload : data to pass to the caller
+# @return payload
 @LodelHook('leapi_get_post')
 @LodelHook('leapi_update_pre')
 @LodelHook('leapi_update_post')
@@ -17,15 +25,17 @@ def dummy_callback(hook_name, caller, payload):
         print("\tHook %s\tcaller %s with %s" % (hook_name, caller, payload))
     return payload
 
-
+## @brief instance method
+# This is an example of a basic plugin's custom method
 @CustomMethod('Object', 'dummy_method')
 def dummy_instance_method(self):
     print("Hello world !\
 I'm a custom method on an instance of class %s" % self.__class__)
 
 
+## @brief instance method
+# This is an example of a basic plugin's custom method
 @CustomMethod('Object', 'dummy_class_method', CustomMethod.CLASS_METHOD)
 def dummy_instance_method(self):
     print("Hello world !\
 I'm a custom method on class %s" % self.__class__)
-