MOD début du cleanage du code de euphorik.js

[euphorik.git] / js / euphorik.js

diff --git a/js/euphorik.js b/js/euphorik.js
index 433c0bc..9dd3357 100755 (executable)
--- a/js/euphorik.js
+++ b/js/euphorik.js
@@ -1,6 +1,8 @@
 // coding: utf-8\r
 \r
-/**
+/**\r
+  * Contient la base javascript pour le site euphorik.ch.\r
+  * Chaque page possède son propre fichier js nommé "page<nom de la page>.js".
   * Auteur : GBurri
   * Date : 6.11.2007
   */
@@ -38,15 +40,17 @@ var conf = {
 \r
 String.prototype.trim = function()\r
 {\r
-       return this.replace(/^\s+|\s+$/g,"");\r
+       return this.replace(/^\s+|\s+$/g, "");\r
 }\r
+\r
 String.prototype.ltrim = function()\r
 {\r
-       return this.replace(/^\s+/,"");\r
+       return this.replace(/^\s+/, "");\r
 }\r
+\r
 String.prototype.rtrim = function()\r
 {\r
-       return this.replace(/\s+$/,"");\r
+       return this.replace(/\s+$/, "");\r
 }\r
 \r
 String.prototype.dump = function()\r
@@ -60,12 +64,16 @@ String.prototype.dump = function()
 }\r
 \r
 ///////////////////////////////////////////////////////////////////////////////////////////////////\r
-
-function Util(serializer)
+\r
+/**\r
+  * Cette classe regroupe des fonctions utilitaires (helpers).\r
+  */
+function Util()
 {\r
    if(typeof XMLSerializer != "undefined")
       this.serializer = new XMLSerializer()
-      
+      \r
+   // fermeture des dialogues d
    jQuery("#info .fermer").click(function(){
       jQuery("#info").slideUp(50) 
    })
@@ -73,7 +81,10 @@ function Util(serializer)
 
 /**
   * Affiche une boite de dialogue avec un message à l'intérieur.
-  * 
+  * @param message le message (string)\r
+  * @param type voir 'messageType'. par défaut messageType.informatif\r
+  * @param les boutons sous la forme d'un objet ou les clefs sont les labels des boutons\r
+  *        et les valeurs les fonctions executées lorsqu'un bouton est activé.
   */
 Util.prototype.messageDialogue = function(message, type, boutons)
 {
@@ -102,11 +113,9 @@ Util.prototype.messageDialogue = function(message, type, boutons)
 }
 var messageType = {informatif: 0, question: 1, erreur: 2}
 \r
-/* obsolète\r
-Util.prototype.log = function(str)\r
-{\r
-}*/\r
-\r
+/**\r
+  * Transforme un document XML en string.\r
+  */\r
 Util.prototype.serializeXML = function(documentXML)\r
 {\r
    if (this.serializer)\r
@@ -765,8 +774,7 @@ jQuery.noConflict()
 // le main
 jQuery(document).ready(
    function()
-   { 
-      
+   {  
       var util = new Util()
       var client = new Client(util)
       var pages = new Pages()