[Jrst-commits] r255 - in jrst/trunk/src/main/java/org/codelutin/jrst: . directive

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) {