February 2009 - Jrst-commits - mailman.cloud.codelutin.com

r256 - in jrst/trunk: . src/test/java/org/codelutin/jrst
by chatellier＠users.labs.libre-entreprise.org 05 Feb '09

05 Feb '09

Author: chatellier Date: 2009-02-05 18:03:06 +0000 (Thu, 05 Feb 2009) New Revision: 256 Modified: jrst/trunk/changelog.txt jrst/trunk/src/test/java/org/codelutin/jrst/JRSTGeneratorTest.java Log: Fix javadoc and copyright dates Modified: jrst/trunk/changelog.txt =================================================================== --- jrst/trunk/changelog.txt 2009-02-05 18:02:48 UTC (rev 255) +++ jrst/trunk/changelog.txt 2009-02-05 18:03:06 UTC (rev 256) @@ -1,5 +1,6 @@ ver-0.8.4 xxx 2009XXXX + * Fix javadoc * Fix anchor in content * Update xml2rst.xsl stylesheet * Re add i18n plugin on build Modified: jrst/trunk/src/test/java/org/codelutin/jrst/JRSTGeneratorTest.java =================================================================== --- jrst/trunk/src/test/java/org/codelutin/jrst/JRSTGeneratorTest.java 2009-02-05 18:02:48 UTC (rev 255) +++ jrst/trunk/src/test/java/org/codelutin/jrst/JRSTGeneratorTest.java 2009-02-05 18:03:06 UTC (rev 256) @@ -38,14 +38,14 @@ @Test public void testRstToHtml() throws Exception { - File test1 = File.createTempFile("jrst-test", ".html"); + File test1 = File.createTempFile("jrst-RstToHtml", ".html"); JRST.main(new String[] { "-t", "rst", "--force", "-o", test1.getAbsolutePath(), "src/test/resources/test.rst", }); test1.delete(); } @Test public void testRstToHtml2() throws Exception { - File test1 = File.createTempFile("jrst-test", ".html"); + File test1 = File.createTempFile("jrst-RstToHtml2", ".html"); JRST.main(new String[] { "-t", "html", "--force", "-o", test1.getAbsolutePath(), "src/test/resources/text.rst" }); test1.delete(); } @@ -53,7 +53,7 @@ @Test public void testRstToDocbook() throws Exception { - File test1 = File.createTempFile("jrst-test", ".dbk"); + File test1 = File.createTempFile("jrst-RstToDocbook", ".dbk"); JRST.main(new String[]{"-t", "docbook", "--force","-o", test1.getAbsolutePath(), "src/test/resources/test.rst"}); test1.delete(); @@ -61,10 +61,10 @@ @Test public void testRstToXdoc() throws Exception { - File test1 = File.createTempFile("jrst-test", ".xdoc"); + File test1 = File.createTempFile("jrst-RstToXdoc", ".xdoc"); JRST.main(new String[] { "-t", "xdoc", "--force","-o", test1.getAbsolutePath(), "src/test/resources/test.rst" }); - test1.delete(); + //test1.delete(); } /** @@ -74,7 +74,7 @@ */ @Ignore public void testRstToXdoc2() throws Exception { - File test1 = File.createTempFile("jrst-test", ".xdoc"); + File test1 = File.createTempFile("jrst-RstToXdoc2", ".xdoc"); JRST.main(new String[] { "-t", "xdoc", "--force","-o", test1.getAbsolutePath(), "src/test/resources/test2.rst" }); test1.delete(); @@ -82,7 +82,7 @@ @Test public void testRstToXdoc3() throws Exception { - File test1 = File.createTempFile("jrst-test", ".xdoc"); + File test1 = File.createTempFile("jrst-RstToXdoc3", ".xdoc"); JRST.main(new String[] { "-t", "xdoc", "--force","-o", test1.getAbsolutePath(), "src/test/resources/test3.rst" }); test1.delete(); @@ -90,7 +90,7 @@ @Test public void testRstToXdoc4() throws Exception { - File test1 = File.createTempFile("jrst-test", ".xdoc"); + File test1 = File.createTempFile("jrst-RstToXdoc4", ".xdoc"); JRST.main(new String[] { "-t", "xdoc", "--force","-o", test1.getAbsolutePath(), "src/test/resources/test4.rst" }); test1.delete(); @@ -98,7 +98,7 @@ @Test public void testRstToXdocJrstSite() throws Exception { - File test1 = File.createTempFile("jrst-test", ".xdoc"); + File test1 = File.createTempFile("jrst-RstToXdocJrstSite", ".xdoc"); JRST.main(new String[] { "-t", "xdoc", "--force","-o", test1.getAbsolutePath(), "src/test/resources/frEntier.rst" }); test1.delete();

1 0

r255 - in jrst/trunk/src/main/java/org/codelutin/jrst: . directive
by chatellier＠users.labs.libre-entreprise.org 05 Feb '09

05 Feb '09

Author: chatellier Date: 2009-02-05 18:02:48 +0000 (Thu, 05 Feb 2009) New Revision: 255 Modified: jrst/trunk/src/main/java/org/codelutin/jrst/AdvancedReader.java jrst/trunk/src/main/java/org/codelutin/jrst/DocumentHandler.java jrst/trunk/src/main/java/org/codelutin/jrst/DocumentWalker.java jrst/trunk/src/main/java/org/codelutin/jrst/JRST.java jrst/trunk/src/main/java/org/codelutin/jrst/JRSTDirective.java jrst/trunk/src/main/java/org/codelutin/jrst/JRSTGenerator.java jrst/trunk/src/main/java/org/codelutin/jrst/JRSTInterface.java jrst/trunk/src/main/java/org/codelutin/jrst/JRSTLexer.java jrst/trunk/src/main/java/org/codelutin/jrst/JRSTReader.java jrst/trunk/src/main/java/org/codelutin/jrst/ReStructuredText.java jrst/trunk/src/main/java/org/codelutin/jrst/directive/ContentDirective.java jrst/trunk/src/main/java/org/codelutin/jrst/directive/DateDirective.java jrst/trunk/src/main/java/org/codelutin/jrst/directive/ImageDirective.java jrst/trunk/src/main/java/org/codelutin/jrst/directive/SectnumDirective.java Log: Fix javadoc and copyright dates Modified: jrst/trunk/src/main/java/org/codelutin/jrst/AdvancedReader.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/AdvancedReader.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/AdvancedReader.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * AdvancedReader.java - * - * Created: 27 oct. 06 00:24:57 - * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst; import org.apache.commons.collections.primitives.ArrayCharList; @@ -69,8 +57,13 @@ * + markChar * </pre> * + * Created: 27 oct. 06 00:24:57 + * * @author poussin - * + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class AdvancedReader { Modified: jrst/trunk/src/main/java/org/codelutin/jrst/DocumentHandler.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/DocumentHandler.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/DocumentHandler.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,7 +15,13 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * +package org.codelutin.jrst; + +import org.dom4j.Document; +import org.dom4j.Element; +import org.dom4j.Text; + +/** * DocumentHandler.java * * Created: 30 oct. 06 10:22:52 @@ -26,18 +32,6 @@ * Last update: $Date$ * by : $Author$ */ - -package org.codelutin.jrst; - -import org.dom4j.Document; -import org.dom4j.Element; -import org.dom4j.Text; - -/** - * @author poussin - * - */ - public interface DocumentHandler { public void startDocument(Document doc); Modified: jrst/trunk/src/main/java/org/codelutin/jrst/DocumentWalker.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/DocumentWalker.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/DocumentWalker.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as Modified: jrst/trunk/src/main/java/org/codelutin/jrst/JRST.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/JRST.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/JRST.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,17 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * JRST.java - * - * Created: 3 nov. 06 20:56:00 - * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ package org.codelutin.jrst; import static org.codelutin.i18n.I18n._; @@ -51,7 +40,6 @@ import javax.xml.transform.Source; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; -import javax.xml.transform.URIResolver; import javax.xml.transform.sax.SAXResult; import javax.xml.transform.stream.StreamSource; @@ -79,7 +67,13 @@ * FIXME: 'JRST --help' doesn't work, but 'JRST --help toto' work :( FIXME: * 'JRST -c' doesn't work, but 'JRST -c toto' * + * Created: 3 nov. 06 20:56:00 + * * @author poussin + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ @CommandLineInterface(application = "JRST") public class JRST { Modified: jrst/trunk/src/main/java/org/codelutin/jrst/JRSTDirective.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/JRSTDirective.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/JRSTDirective.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,9 +15,14 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * JRSTDirective.java - * +package org.codelutin.jrst; + +import org.dom4j.Element; +import org.dom4j.Node; + +/** + * JRSTDirective. + * * Created: 4 nov. 06 12:49:39 * * @author poussin @@ -26,17 +31,6 @@ * Last update: $Date$ * by : $Author$ */ - -package org.codelutin.jrst; - -import org.dom4j.Element; -import org.dom4j.Node; - -/** - * @author poussin - * - */ - public interface JRSTDirective { /** Modified: jrst/trunk/src/main/java/org/codelutin/jrst/JRSTGenerator.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/JRSTGenerator.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/JRSTGenerator.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * JRSTGenerator.java - * - * Created: 30 oct. 06 00:14:18 - * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst; import org.apache.commons.logging.Log; @@ -59,17 +47,23 @@ import java.util.LinkedList; /** - * Cette classe contient plusieurs methode pour generer, soit en utilisant une + * Cette classe contient plusieurs methodes pour générer, soit en utilisant une * feuille de style {@link #generate(Document, URL, Writer)}, soit un * {@link ContentHandler} avec {@link #generate(Document, ContentHandler)}, soit * {@link DocumentHandler} avec {@link #generate(Document, ContentHandler)} ou - * bien regenerer du RST avec {@link #generate(Document)} dans les deux dernier - * cas il faut passer un {@link Writer} en paremetre du constructeur. + * bien regénérer du RST avec {@link #generate(Document)} dans les deux derniers + * cas il faut passer un {@link Writer} en parametre du constructeur. * <p> * On peut aussi transformer le {@link Document} en un autre {@link Document} - * avec {@link #transform(Document, URL)} - * + * avec {@link #transform(Document, URL, String...)} + * + * Created: 30 oct. 06 00:14:18 + * * @author poussin + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class JRSTGenerator implements DocumentHandler { @@ -114,14 +108,12 @@ * * @param doc * @throws IOException - * @throws TransformerException */ public void generate(Document doc) throws IOException { generate(doc, this); } - public void generate(Document doc, DocumentHandler handler) - throws IOException { + public void generate(Document doc, DocumentHandler handler) { DocumentWalker walker = new DocumentWalker(handler); walker.walk(doc); } @@ -287,10 +279,7 @@ } /* - * (non-Javadoc) - * - * @see org.xml.sax.EntityResolver#resolveEntity(java.lang.String, - * java.lang.String) + * @see org.xml.sax.EntityResolver#resolveEntity(java.lang.String, java.lang.String) */ public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException { @@ -614,8 +603,8 @@ /** * Ecrit le text, si indent est vrai, alors chaque ligne est indentée * - * @param text - * @param indent + * @param text text to write + * @param doIndent do indent */ protected void write(String text, boolean doIndent) { try { Modified: jrst/trunk/src/main/java/org/codelutin/jrst/JRSTInterface.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/JRSTInterface.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/JRSTInterface.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,6 +1,5 @@ -/** - * *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin +/* *##% JRst + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -30,7 +29,6 @@ import java.awt.event.ActionListener; import java.io.File; import java.util.LinkedList; -import java.util.Locale; import javax.swing.BoxLayout; import javax.swing.ButtonGroup; @@ -47,10 +45,19 @@ import javax.swing.event.ChangeEvent; import javax.swing.event.ChangeListener; -import org.codelutin.i18n.I18n; import org.codelutin.util.Resource; +/** + * JRST main interface. + * + * @author chatellier + * @version $Revision$ + * + * Last update : $Date$ + * By : $Author$ + */ public class JRSTInterface extends JDialog { + /** serialVersionUID */ private static final long serialVersionUID = 5327326730753891936L; Modified: jrst/trunk/src/main/java/org/codelutin/jrst/JRSTLexer.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/JRSTLexer.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/JRSTLexer.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * JRSTLexer.java - * - * Created: 28 oct. 06 00:44:20 - * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst; import org.apache.commons.logging.Log; @@ -55,9 +43,13 @@ * Pour mettre en place ce mecanisme le plus simple est d'utiliser les methodes * {@link JRSTLexer#beginPeek()} et {@link JRSTLexer#endPeek()} * - * - * + * Created: 28 oct. 06 00:44:20 + * * @author poussin, letellier + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class JRSTLexer { @@ -225,7 +217,6 @@ /** * remove one element from list of element already read * - * @return * @throws IOException */ public void remove() throws IOException { @@ -2244,7 +2235,6 @@ * return the number of line read * * @return int - * @throws IOException */ public int getLineNumber() { return in.getLineNumber(); @@ -2254,7 +2244,6 @@ * return the number of char read * * @return int - * @throws IOException */ public int getCharNumber() { return in.getCharNumber(); Modified: jrst/trunk/src/main/java/org/codelutin/jrst/JRSTReader.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/JRSTReader.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/JRSTReader.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -147,15 +147,15 @@ */ /** - * * Le principe est d'utiliser les methodes peek* {@link JRSTLexer} pour + * Le principe est d'utiliser les methodes peek* {@link JRSTLexer} pour * prendre l'element que l'on attend, si la methode retourne null ou un autre * element et bien c que ce n'est pas le bon choix, cela veut dire que l'element * courant est fini d'etre lu (plus de paragraphe dans la section par exemple) * ou qu'il y a une erreur dans le fichier en entre. * <p> * On construit un arbre XML representant le RST au fur et a mesure, on peut - * ensuite appliquer une fueille de style ou autre chose avec - * {@link JRSTGeneratorTest} + * ensuite appliquer une feuille de style ou autre chose avec + * {@link JRSTGenerator} * * <p> * Tous les elements ont un attribut level qui permet de savoir on il est dans @@ -263,7 +263,13 @@ * warning (done) * </pre> * + * Created: 27 oct. 06 00:15:34 + * * @author poussin, letellier + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class JRSTReader { @@ -320,6 +326,7 @@ } /** + * @param name * @return the defaultDirectives */ public static JRSTDirective getDefaultDirective(String name) { @@ -327,8 +334,8 @@ } /** - * @param defaultDirectives - * the defaultDirectives to set + * @param name + * @param directive the defaultDirectives to set */ public static void addDefaultDirectives(String name, JRSTDirective directive) { JRSTReader.defaultDirectives.put(name, directive); @@ -342,8 +349,8 @@ } /** - * @param JRSTDirective - * the defaultDirectives to set + * @param name + * @param directive the defaultDirectives to set */ public void addDirectives(String name, JRSTDirective directive) { directives.put(name, directive); @@ -355,8 +362,7 @@ * * @param reader * @return - * @throws IOException - * @throws DocumentException + * @throws Exception */ public Document read(Reader reader) throws Exception { JRSTLexer lexer = new JRSTLexer(reader); @@ -998,7 +1004,6 @@ * @return Element * @throws Exception */ - @SuppressWarnings("unchecked") private Element[] composeFootnote(Element item) throws Exception { Element[] result = null; if (itemEquals("footnotes", item)) { @@ -1109,7 +1114,6 @@ * @throws Exception * @throws DocumentException */ - @SuppressWarnings("unchecked") private Element composeOptionList(JRSTLexer lexer) throws DocumentException, Exception { Element item = lexer.peekOption(); @@ -1206,8 +1210,6 @@ * @return Element * @throws Exception */ - - @SuppressWarnings("unchecked") private Element composeLineBlock(JRSTLexer lexer, Element item) throws Exception { Element result = null; @@ -1279,7 +1281,6 @@ * @throws Exception * */ - private Element composeBlockQuote(Element item) throws Exception { Element result = null; result = DocumentHelper.createElement(BLOCK_QUOTE); @@ -1403,7 +1404,6 @@ * @return Element * */ - @SuppressWarnings("unchecked") private Element composeTable(Element item) throws Exception { Element result = DocumentHelper.createElement(TABLE); @@ -1850,8 +1850,8 @@ * name * @param Element * e - * @param boolean throwError - * @param boolean eof + * @param throwError + * @param eof * @return boolean * @throws DocumentException */ Modified: jrst/trunk/src/main/java/org/codelutin/jrst/ReStructuredText.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/ReStructuredText.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/ReStructuredText.java 2009-02-05 18:02:48 UTC (rev 255) @@ -15,8 +15,12 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * Docbook.java +package org.codelutin.jrst; + +import java.util.regex.Pattern; + +/** + * ReStructuredText. * * Created: 27 oct. 06 11:10:30 * @@ -26,16 +30,6 @@ * Last update: $Date$ * by : $Author$ */ - -package org.codelutin.jrst; - -import java.util.regex.Pattern; - -/** - * @author poussin - * - */ - public class ReStructuredText { public static final String DTD = "http://docutils.sourceforge.net/docs/ref/docutils.dtd"; Modified: jrst/trunk/src/main/java/org/codelutin/jrst/directive/ContentDirective.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/directive/ContentDirective.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/directive/ContentDirective.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -22,11 +22,18 @@ import org.dom4j.Element; import org.dom4j.Node; +/** + * ContentDirective + * + * @author poussin + * @version $Revision$ + * + * Last update : $Date$ + * By : $Author$ + */ public class ContentDirective implements JRSTDirective { /* - * (non-Javadoc) - * * @see org.codelutin.jrst.JRSTDirective#parse(org.dom4j.Element) */ public Node parse(Element e) { Modified: jrst/trunk/src/main/java/org/codelutin/jrst/directive/DateDirective.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/directive/DateDirective.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/directive/DateDirective.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * DateDirective.java - * - * Created: 4 nov. 06 13:29:25 - * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst.directive; import org.codelutin.jrst.JRSTDirective; @@ -41,14 +29,17 @@ /** * .. date:: .. time:: * + * Created: 4 nov. 06 13:29:25 + * * @author poussin - * + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class DateDirective implements JRSTDirective { /* - * (non-Javadoc) - * * @see org.codelutin.jrst.JRSTDirective#parse(org.dom4j.Element) */ public Node parse(Element e) { Modified: jrst/trunk/src/main/java/org/codelutin/jrst/directive/ImageDirective.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/directive/ImageDirective.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/directive/ImageDirective.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * Image.java - * - * Created: 4 nov. 06 12:52:02 - * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst.directive; import org.codelutin.jrst.JRSTDirective; @@ -44,7 +32,13 @@ * .. image:: picture.jpeg :height: 100 :width: 200 :scale: 50 :alt: alternate * text :align: right * + * Created: 4 nov. 06 12:52:02 + * * @author poussin + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class ImageDirective implements JRSTDirective { Modified: jrst/trunk/src/main/java/org/codelutin/jrst/directive/SectnumDirective.java =================================================================== --- jrst/trunk/src/main/java/org/codelutin/jrst/directive/SectnumDirective.java 2009-02-05 17:30:06 UTC (rev 254) +++ jrst/trunk/src/main/java/org/codelutin/jrst/directive/SectnumDirective.java 2009-02-05 18:02:48 UTC (rev 255) @@ -1,5 +1,5 @@ /* *##% JRst - * Copyright (C) 2004 - 2008 CodeLutin + * Copyright (C) 2004 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -22,11 +22,18 @@ import org.dom4j.Element; import org.dom4j.Node; +/** + * SectnumDirective. + * + * @author poussin + * @version $Revision$ + * + * Last update : $Date$ + * By : $Author$ + */ public class SectnumDirective implements JRSTDirective { /* - * (non-Javadoc) - * * @see org.codelutin.jrst.JRSTDirective#parse(org.dom4j.Element) */ public Node parse(Element e) {

1 0

r254 - in maven-jrst-plugin/trunk: . src/main/java/org/codelutin/jrst/plugin src/site/fr/rst
by chatellier＠users.labs.libre-entreprise.org 05 Feb '09

05 Feb '09

Author: chatellier Date: 2009-02-05 17:30:06 +0000 (Thu, 05 Feb 2009) New Revision: 254 Modified: maven-jrst-plugin/trunk/changelog.txt maven-jrst-plugin/trunk/pom.xml maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java maven-jrst-plugin/trunk/src/site/fr/rst/index.rst Log: Set default locale to 'en' Remove some required setting for parameter with default values Write javadoc in english Modified: maven-jrst-plugin/trunk/changelog.txt =================================================================== --- maven-jrst-plugin/trunk/changelog.txt 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/changelog.txt 2009-02-05 17:30:06 UTC (rev 254) @@ -1,3 +1,8 @@ +ver-0-8-4 chatellier 200902xx + * 20090205 Set default locale to 'en' + * 20090205 Remove some required setting for parameter with default values + * 20090205 Write javadoc in english + ver-0-8-3 thimel 200810XX * 20081008 [chemit] refactor plugin to generate ony when required * 20081008 [chemit] Using lutinpluginproject 3.0 in a better way :) Modified: maven-jrst-plugin/trunk/pom.xml =================================================================== --- maven-jrst-plugin/trunk/pom.xml 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/pom.xml 2009-02-05 17:30:06 UTC (rev 254) @@ -36,7 +36,7 @@ <name>Maven JRST Plugin</name> <version>0.8.4-SNAPSHOT</version> <description> - Plugin pour maven2 pour la génération de xdoc à partir de fichiers RST. + Maven2 plugin to generate reStructuredText file into xDoc. </description> <inceptionYear>2006</inceptionYear> @@ -54,6 +54,7 @@  <maven.site.locales>fr,en</maven.site.locales> + <jrst.version>0.8.4-SNAPSHOT</jrst.version> </properties>  Modified: maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java =================================================================== --- maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java 2009-02-05 17:30:06 UTC (rev 254) @@ -1,5 +1,5 @@ /* *##% Plugin maven JRst - * Copyright (C) 2006 - 2008 CodeLutin + * Copyright (C) 2006 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,22 +15,10 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * GenerationJRstException.java - * - * Created: 14 avril 2006 - * - * @author ruchaud - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst.plugin; /** - * GenerationJRstException + * GenerationJRstException. * * @author ruchaud * @version $Revision$ @@ -42,9 +30,9 @@ /** serialVersionUID */ private static final long serialVersionUID = 7121169280356405413L; - - static private String filesErrors = ""; + protected static String filesErrors = ""; + public GenerationJRstException(String fileIn) { filesErrors += fileIn + "\n"; } Modified: maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java =================================================================== --- maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java 2009-02-05 17:30:06 UTC (rev 254) @@ -1,5 +1,5 @@ /* *##% Plugin maven JRst - * Copyright (C) 2006 - 2008 CodeLutin + * Copyright (C) 2006 - 2009 CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * JRstPlugin.java - * - * Created: 14 avril 2006 - * - * @author ruchaud - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst.plugin; import org.apache.maven.plugin.AbstractMojo; @@ -58,111 +46,125 @@ * * @goal jrst * @phase pre-site + * + * Created: 14 avril 2006 + * + * @author ruchaud + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class JRstPlugin extends AbstractMojo { - /** La liste des ressource a copier si rien n'est specifie via la propriete includeResources */ + /** + * Default copy patterns if {@link #includeResources} + * is <tt>null</tt>. + */ protected static final String[] DEFAULT_INCLUDE_RESOURCES = { - "**\\/*.png", - "**\\/*.jpeg", - "**\\/*.jpg", - "**\\/*.gif" + "**\\/*.png", + "**\\/*.jpeg", + "**\\/*.jpg", + "**\\/*.gif" }; - /** - * Répertoire source des fichiers Rst + * Site source directory. * * @parameter default-value="src/site" - * @required + * @since 0.8 */ protected File directoryIn; /** - * Encoding en entrée + * Site source encoding. * * @parameter default-value="UTF-8" + * @since 0.8 */ protected String inputEncoding = "UTF-8"; /** - * Encoding en sortie + * Site generated directory. * - * @parameter default-value="UTF-8" + * @parameter default-value="target/generated-site" + * @since 0.8 */ - protected String outputEncoding = "UTF-8"; - + protected File directoryOut; + /** - * Répertoire cible des fichiers xdoc générée + * Site generated encoding. * - * @parameter default-value="target/generated-site" - * @required + * @parameter default-value="UTF-8" + * @since 0.8 */ - protected File directoryOut; + protected String outputEncoding = "UTF-8"; /** - * Répertoire cible des fichiers resources générée + * Copied resource destination directory. * * @parameter default-value="target/generated-site/resources" - * @required + * @since 0.8 */ protected File resourceDirectoryOut; /** - * Arréte la génération en cas d'erreurs + * Ignore errors. * * @parameter default-value="true" + * @since 0.8 */ protected boolean ignoreErrors = true; /** - * Ecrase les fichiers générés + * Overwrite already existing generated files. * * @parameter default-value="ifnewer" + * @since 0.8 */ protected String overwrite = "ifnewer"; /** - * La locale par defaut a utiliser. + * Default locale for generated files structure. * - * @parameter default-value="fr" + * @parameter default-value="en" + * @since 0.8 */ - protected String defaultLocale = "fr"; + protected String defaultLocale = "en"; /** - * Permet d'obtenir plus d'information + * Verbose. * - * @parameter expression="${jrst.verbose}" default-value="${maven.verbose}" + * @parameter default-value="${maven.verbose}" expression="${jrst.verbose}" + * @since 0.8 */ protected boolean verbose; /** - * Flag pour forcer la generation des rst et la copie des resources. + * Overwrite resources. * - * @parameter expression="${jrst.force}" default-value="false" + * @parameter default-value="false" expression="${jrst.force}" + * @since 0.8 */ protected boolean force; /** - * La liste des ressources a recopier + * Resources patterns to copy. * * @parameter expression="${jrst.includeResources}" + * @since 0.8.3 */ protected String[] includeResources; /** Number of generated files. */ protected int numberFilesGenerates; - /** - * Retourne la langue par defaut precisé dans le pom.xml - * - * @return la langue par defaut precisé dans le pom.xml + /** + * Get overwrite. + * + * @see JRST.Overwrite + * @return the overwrite */ - protected String getDefaultLocale() { - return defaultLocale; - } - - /** @return the overwrite */ public JRST.Overwrite getOverwrite() { JRST.Overwrite result = JRST.Overwrite.NEVER; if (this.overwrite.contains("new")) { @@ -174,28 +176,33 @@ return result; } + /** + * Execute mojo. + */ public void execute() throws MojoExecutionException { try { actionGenerate(); } catch (GenerationJRstException e) { - getLog().error("Error during generation for :\n" - + GenerationJRstException.getFilesErrors()); + getLog().error( + "Error during generation for :\n" + + GenerationJRstException.getFilesErrors()); if (!ignoreErrors) { - throw new MojoExecutionException("Erreur lors de l'execution"); + throw new MojoExecutionException("Error during generation"); } } actionCopy(); } - private void actionGenerate() { - getLog().info("Génération des fichier xdocs à partir des fichiers rst"); + protected void actionGenerate() { + getLog().info("Generating reStructuredText files into xDoc"); - MirroredFileUpdater rstUpdater = new RstUpdater(directoryIn, directoryOut, defaultLocale); - + MirroredFileUpdater rstUpdater = new RstUpdater(directoryIn, + directoryOut, defaultLocale); + numberFilesGenerates = 0; DirectoryScanner ds = new DirectoryScanner(); ds.setBasedir(directoryIn); - ds.setIncludes(new String[]{"**\\/*.rst"}); + ds.setIncludes(new String[] { "**\\/*.rst" }); ds.scan(); String[] files = ds.getIncludedFiles(); @@ -204,7 +211,7 @@ if (!force && rstUpdater.isFileUpToDate(in)) { if (verbose) { - getLog().info("skip up-to-date rst file : " + in); + getLog().info("Skip up-to-date reStructuredText file : " + in); } continue; } @@ -212,7 +219,8 @@ doAction(in, rstUpdater.getMirrorFile(in)); } - getLog().info("Generating " + numberFilesGenerates + " files to " + directoryOut); + getLog().info("Generating " + numberFilesGenerates + " files to " + + directoryOut); } public boolean doAction(File in, File out) { @@ -220,8 +228,8 @@ getLog().info("Using " + in); try { - JRST.generate(JRST.TYPE_XDOC, in, inputEncoding, - out, outputEncoding, getOverwrite()); + JRST.generate(JRST.TYPE_XDOC, in, inputEncoding, out, + outputEncoding, getOverwrite()); numberFilesGenerates++; } catch (Exception e) { getLog().error(e); @@ -238,27 +246,30 @@ } protected void actionCopy() { - getLog().info("Copie des fichiers images"); + getLog().info("Copy resources files"); - MirroredFileUpdater resourceUpdater = new RessourceUpdater(directoryIn, resourceDirectoryOut, defaultLocale); - + MirroredFileUpdater resourceUpdater = new RessourceUpdater(directoryIn, + resourceDirectoryOut, defaultLocale); + DirectoryScanner ds = new DirectoryScanner(); ds.setBasedir(directoryIn); - ds.setIncludes(includeResources == null || includeResources.length == 0 ? DEFAULT_INCLUDE_RESOURCES : includeResources); + ds.setIncludes(includeResources == null + || includeResources.length == 0 ? DEFAULT_INCLUDE_RESOURCES + : includeResources); ds.scan(); for (String file : ds.getIncludedFiles()) { File in = new File(directoryIn, file); if (!force && resourceUpdater.isFileUpToDate(in)) { if (verbose) { - getLog().info("skip up-to-date resource file : " + in); + getLog().info("Skip up-to-date resource file : " + in); } // do not copy the resource continue; } File out = resourceUpdater.getMirrorFile(in); if (verbose) { - getLog().info("copy resource " + in + " to " + out); + getLog().info("Copy resource " + in + " to " + out); } try { FileUtil.copy(in, out); @@ -269,7 +280,7 @@ } /** - * An updater for rst files + * An updater for rst files. * * @author chemit */ @@ -277,23 +288,26 @@ protected String defaultLocale; - protected RstUpdater(File sourceDirectory, File destinationDirectory, String defaultLocale) { + protected RstUpdater(File sourceDirectory, File destinationDirectory, + String defaultLocale) { super(sourceDirectory, destinationDirectory); this.defaultLocale = defaultLocale; } public File getMirrorFile(File f) { String file = f.getAbsolutePath().substring(prefixSourceDirecotory); - file = file.replace(".rst", ".xml").replaceFirst("([/\\\\])rst([/\\\\])", "$1xdoc$2"); + file = file.replace(".rst", ".xml").replaceFirst( + "([/\\\\])rst([/\\\\])", "$1xdoc$2"); if (defaultLocale != null && !"".equals(defaultLocale)) { - file = file.replaceFirst("([/\\\\])" + defaultLocale + "([/\\\\])", "$1"); + file = file.replaceFirst("([/\\\\])" + defaultLocale + + "([/\\\\])", "$1"); } return new File(destinationDirectory, file); } } /** - * An updater for resources files + * An updater for resources files. * * @author chemit */ @@ -301,7 +315,8 @@ protected String defaultLocale; - protected RessourceUpdater(File sourceDirectory, File destinationDirectory, String defaultLocale) { + protected RessourceUpdater(File sourceDirectory, + File destinationDirectory, String defaultLocale) { super(sourceDirectory, destinationDirectory); this.defaultLocale = defaultLocale; } @@ -310,7 +325,8 @@ String file = f.getAbsolutePath().substring(prefixSourceDirecotory); file = file.replaceFirst("([/\\\\])rst([/\\\\])", "$1$2"); if (defaultLocale != null && !"".equals(defaultLocale)) { - file = file.replaceFirst("([/\\\\])" + defaultLocale + "([/\\\\])", "$1"); + file = file.replaceFirst("([/\\\\])" + defaultLocale + + "([/\\\\])", "$1"); } return new File(destinationDirectory, file); } Modified: maven-jrst-plugin/trunk/src/site/fr/rst/index.rst =================================================================== --- maven-jrst-plugin/trunk/src/site/fr/rst/index.rst 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/src/site/fr/rst/index.rst 2009-02-05 17:30:06 UTC (rev 254) @@ -6,12 +6,12 @@ Présentation ------------ -Le plugin maven pour utiliser la librairie jrst. +Le plugin maven2 pour utiliser la librairie jrst. Fonctionnement -------------- -Maven ne gere pas le RST par defaut, voilà pourquoi le plugin +Maven ne gère pas le RST par défaut, voilà pourquoi le plugin maven-jrst-plugin a été développé. Il utilise donc une structure similaire des sources des sites @@ -34,7 +34,7 @@ <plugin> <groupId>org.codelutin</groupId> <artifactId>maven-jrst-plugin</artifactId> - <version>${jrst.version}</version> + <version>${maven-jrst-plugin.version}</version> <configuration> <directoryIn>${basedir}/src/site</directoryIn> <directoryOut>${project.build.directory}/generated-site</directoryOut> @@ -56,8 +56,8 @@ pre-site : maven-antrun-plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Ce plugin est utilisé pour copier les fichier "non-rst" -dans le répertoire de generation de site. +Ce plugin est utilisé pour copier les fichiers "non-rst" +dans le répertoire de génération de site. :: @@ -69,7 +69,9 @@ <configuration> <tasks> <mkdir dir="${basedir}/src/site"/> - <copy todir="${project.build.directory}/generated-site" verbose="${maven.verbose}" overwrite="false"> + <copy todir="${project.build.directory}/generated-site" + verbose="${maven.verbose}" + overwrite="false"> <fileset dir="${basedir}/src/site"> <exclude name="**/rst/**"/> </fileset> @@ -91,7 +93,6 @@ <plugin> <artifactId>maven-site-plugin</artifactId> - <version>2.0-beta-7</version> <configuration> <siteDirectory>${project.build.directory}/generated-site</siteDirectory> <inputEncoding>UTF-8</inputEncoding>

1 0