Normalize comments for MlString

Lodel/utils/mlstring.py

@@ -2,31 +2,46 @@
 
 import json
 
+## Handle string with translations
 class MlString(object):
-    """ Handle string with translations """
 
+    ## Instanciate a new string with translation
+    #
+    # @param translations dict: With key = lang and value the translation
     def __init__(self, translations = dict()):
         self.translations = translations
-
+    
+    ## Return a translation
+    # @param lang str: The lang
+    # @return An empty string if the wanted lang don't exist
+    # @warning Returns an empty string if the wanted translation didn't exists
+    # @todo Raise an exception if not exists ?
     def get(self, lang):
         if not lang in self.translations:
             return ''
 
         return self.translations[lang]
-
+    
+    ## Set a translation for this MlString
+    # @param lang str: The language
+    # @param text str: The translation
     def set(self, lang, text):
         if not text:
             if lang in self.translations:
                 del(self.translations[lang])
         else:
             self.translations[lang] = text
-
+    ## String representation
+    # @return A json dump of the MlString::translations dict
     def __str__(self):
         if self.translations:
             return json.dumps(self.translations)
         else:
             return ""
 
+    ## Test if two MlString instance are equivalent
+    # @param other MlString : Another MlString instance
+    # @return True or False
     def __eq__(self, other):
         if not isinstance(other, MlString):
             return False
@@ -38,9 +53,14 @@ class MlString(object):
         return True
 
     @staticmethod
+    ## Instanciate a MlString from json
+    # @param json_string str: Json datas in a string
+    # @return A new MlString instance
+    # @warning fails silently
     def load(json_string):
         if isinstance(json_string, str) and json_string != '':
             translations = json.loads(json_string)
         else:
             translations = dict()
         return MlString(translations)
+