Changeset 2168

Timestamp:

04/07/10 23:05:11 (14 years ago)

Author:

abompard

Message:

Documentation

Location:

plugins/odt

Files:

• Makefile (modified) (1 diff)
• docs (added)
• inc/class.odt.dcodf.php (modified) (6 diffs)

plugins/odt/Makefile

@@ -19 +19 @@
      rm -f $(ARCHIVE)
 
+docs:
+     phpdoc -o HTML:Smarty:default -d $(CURDIR) -s -ti "Dotclear ODT export" -t $(CURDIR)/docs
 
-.PHONY: tarball clean
+.PHONY: tarball clean docs

plugins/odt/inc/class.odt.dcodf.php

@@ -171 +171 @@
       * Gestion des images locales (sur ce serveur)
       *
-      * Doit etre appele comme callback d'une expression rationelle. Délègue
+      * Doit être appelé comme callback d'une expression rationelle. Délègue
       * tout le travail d'insertion à $this.handleImg()
       *
@@ -184 +184 @@
 
      /*
-      * Telechargement des images distantes avec cURL
-      *
-      * Doit etre appele comme callback d'une expression rationelle. Délègue
+      * Téléchargement des images distantes avec cURL
+      *
+      * Doit être appelé comme callback d'une expression rationelle. Délègue
       * tout le travail d'insertion à $this.handleImg()
       *
@@ -237 +237 @@
           
      /**
-      * Ajoute une image aux fichiers a importer. L'image doit etre ajoutee au texte par un autre moyen
+      * Ajoute une image aux fichiers à importer
+      *
+      * L'image doit être ajoutée au texte par un autre moyen.
       *
       * @param string $filename chemin vers une image
@@ -305 +307 @@
       * Exporte le fichier par HTTP en tant qu'attachement
       *
-      * @param string $name (optionnel)
+      * @param string $name nom du fichier à télécharger (optionnel)
       * @throws OdfException
       */
@@ -326 +328 @@
       *
       * @param string $style style au format ODT
+      * @param boolean $mainstyle le style est-il un style principal ou un style automatique
       */
      public function importStyle($style, $mainstyle=false)
@@ -345 +348 @@
 
      /**
-      * Ajoute une police de caracteres
-      *
-      * @param string $style police au format ODT
+      * Ajoute une police de caractères
+      *
+      * @param string $font police au format ODT
       */
      public function importFont($font)