Browse Source

Comments update

Yann Weber 9 years ago
parent
commit
e530211a1e

+ 2
- 0
EditorialModel/__init__.py View File

@@ -0,0 +1,2 @@
1
+## @package EditorialModel
2
+# @brief Group all objects usefull for editorial model management

+ 2
- 0
EditorialModel/backend/__init__.py View File

@@ -0,0 +1,2 @@
1
+## @package EditorialModel.backend
2
+# @brief Backend that allows the EM to handle different data sources

+ 6
- 3
EditorialModel/backend/json_backend.py View File

@@ -1,7 +1,10 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 
3
-## @file json_backend.py
4
-# Load representation of an EditorialModel from a json file
3
+## @package EditorialModel.backend.json_backend
4
+# @brief Handle json files
5
+# 
6
+# Allows an editorial model to be loaded/saved in
7
+# json format
5 8
 
6 9
 import json
7 10
 import datetime
@@ -67,4 +70,4 @@ class EmBackendJson(object):
67 70
     # @return bool
68 71
     # @todo à implémenter
69 72
     def save(self):
70
-        return True
73
+        return True

+ 4
- 2
EditorialModel/components.py View File

@@ -1,7 +1,9 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 
3
-## @file components.py
4
-# Defines the EditorialModel::components::EmComponent class and the EditorialModel::components::ComponentNotExistError exception class
3
+## @package EditorialModel.components
4
+# @brief Base objects for all EditorialModel components
5
+# 
6
+# Defines the EditorialModel::components::EmComponent class
5 7
 
6 8
 import datetime
7 9
 import logging

+ 6
- 0
EditorialModel/migrationhandler/__init__.py View File

@@ -0,0 +1,6 @@
1
+## @package EditorialModel.migrationhandler
2
+# @brief Tell to an editorial model wether or not a wanted modification is possible
3
+#
4
+# The migration handler provide an API for the EditorialModel to ask wether or not a model modification
5
+# is possible/allowed.
6
+#

+ 5
- 0
EditorialModel/migrationhandler/dummy.py View File

@@ -1,5 +1,10 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 
3
+## @package EditorialModel.migrationhandler.dummy
4
+# @brief A dummy migration handler
5
+#
6
+# According to it every modifications are possible
7
+#
3 8
 
4 9
 ## Manage Model changes
5 10
 class DummyMigrationHandler(object):

Loading…
Cancel
Save