Comments update for doxygen doc

Now we have a main page on doxygen

Lodel/__init__.py

@@ -0,0 +1,26 @@
+## @mainpage
+#
+# @section Introduction
+#
+# For basics Lodel2 configuration & usage see README.md
+#
+# @section mainpage_pkg_list Main packages
+#
+# - Lodel
+#  - Lodel.settings
+# - EditorialModel
+#  - EditorialModel.fieldtypes
+#  - EditorialModel.backend
+# - @ref leapi
+# - DataSource
+#  - DataSource.MySQL
+# 
+# @section mainpage_docs Dev ressources
+#
+# @subsection mainpage_docs_leapi LeAPI
+#
+# - LeAPI objects instanciation : @ref lecrud_instanciation
+# - Querying leapi : @ref api_user_side
+#
+# @subsection mainpage_docs_configs Lodel2 settings
+# - Lodel2 settings handling : @ref lodel_settings

Lodel/settings_format.py

@@ -1,5 +1,7 @@
 #-*- coding: utf-8 -*-
+## @package Lodel.settings_format Rules for settings
 
+## @brief List mandatory configurations keys
 MANDATORY = [
     'debug',
     'debug_sql',
@@ -13,6 +15,7 @@ MANDATORY = [
     'migration_options',
 ]
 
+## @brief List allowed (but not mandatory) configurations keys
 ALLOWED = [
     'em_graph_output',
     'em_graph_format',

install/__init__.py

@@ -0,0 +1 @@
+## @package install Regroup files and files templates designed to compose a lodel instance

leapi/__init__.py

@@ -0,0 +1 @@
+## @package leapi Lodel Editorial API : accessing lodel2 datas & documents

leapi/leobject.py

@@ -1,12 +1,10 @@
 #-*- coding: utf-8 -*-
 
-## @package leobject API to access lodel datas
+## @package leapi.leobject
+# @brief Contains abstract class designed to be implemented by LeObject
 #
 # This package contains abstract classes leapi.leclass.LeClass , leapi.letype.LeType, leapi.leapi._LeObject.
 # Those abstract classes are designed to be mother classes of dynamically generated classes ( see leapi.lefactory.LeFactory )
-
-## @package leapi.leobject
-# @brief Abstract class designed to be implemented by LeObject
 #
 # @note LeObject will be generated by leapi.lefactory.LeFactory
 

leapi/letype.py

@@ -1,12 +1,7 @@
 #-*- coding: utf-8 -*-
 
-## @package leobject API to access lodel datas
-#
-# This package contains abstract classes leapi.leclass.LeClass , leapi.letype.LeType, leapi.leapi._LeObject.
-# Those abstract classes are designed to be mother classes of dynamically generated classes ( see leapi.lefactory.LeFactory )
-
-## @package leapi.leobject
-# @brief Abstract class designed to be implemented by LeObject
+## @package leapi.letype
+# @brief Contains abstract class designed to be implemented by LeType
 #
 # @note LeObject will be generated by leapi.lefactory.LeFactory
 

lodel_init.sh

@@ -32,6 +32,7 @@ echo "Creating lodel instance directory '$instdir'"
 mkdir -pv "$instdir"
 
 cp -v $libdir/install/* $instdir
+rm -fv $instdir/__init__.py
 
 sed -i -e "s#LODEL2_LIB_ABS_PATH#$libdir#" "$settings"
 sed -i -e "s#LODEL2_INSTANCE_NAME#$name#" "$settings"

refreshdyn.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+## @package refreshdyn Python script designed to generate dynamic API
+# @see leapi.lefactory
 
 import sys
 from EditorialModel.model import Model

settings.py

@@ -1,4 +1,5 @@
 #-*- coding:utf8 -*-
+## @package settings Configuration file
 
 import pymysql