Author: mfortun Date: 2011-08-30 16:10:58 +0200 (Tue, 30 Aug 2011) New Revision: 1213 Url: http://nuiton.org/repositories/revision/wikitty/1213 Log: *add javadoc Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/CodeDecorator.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/EvalInterface.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/MimeTypePubHelper.java Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/CodeDecorator.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/CodeDecorator.java 2011-08-30 13:04:45 UTC (rev 1212) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/CodeDecorator.java 2011-08-30 14:10:58 UTC (rev 1213) @@ -24,7 +24,16 @@ import org.nuiton.wikitty.publication.entities.WikittyPubTextHelper; import org.nuiton.wikitty.search.operators.Element; - +/** + * This class is used to decorate wikitty pub text content. + * Used before compile wikittyPubText to encapsulated content inside java method. + * Used to apply filter over wikittyPubText content when containing ui directive + * of others directive that need to be filtered before rendering. + * Directive that have to be encapsulate inside script vars + * + * @author mfortun + * + */ public class CodeDecorator { protected static final String FILTERS_FILE_NAME_REGEX = "filters-\\w*\\.properties"; @@ -42,6 +51,7 @@ static protected String MIME_SEP = "/"; + // TODO mfortun-2011-08-30 move those to properties file. static protected String filtersOptionDirName = "filters-properties/"; static protected String filtersOptionDefault = "filters-default.properties"; Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/EvalInterface.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/EvalInterface.java 2011-08-30 13:04:45 UTC (rev 1212) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/EvalInterface.java 2011-08-30 14:10:58 UTC (rev 1213) @@ -2,13 +2,34 @@ import java.util.List; - +/** + * Interface of the eval action. Used + * @author mfortun + * + */ public interface EvalInterface { + /** + * eval the current publicat ion context + * @param context the current context + * @param subContext list of the subcontext + * @return the result of the evaluation + */ public Object doAction(PublicationContext context, List<String> subContext); + /** + * eval the current publication context + * @param context the current context + * @param subContextAsText the string to be evaluated + * @return the result of the evaluation + */ public Object doAction(PublicationContext context, String subContextAsText); + /** + * eval the current publication context + * @param context the current context + * @return the result of the evaluation + */ public Object doAction(PublicationContext context); } \ No newline at end of file Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/MimeTypePubHelper.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/MimeTypePubHelper.java 2011-08-30 13:04:45 UTC (rev 1212) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/MimeTypePubHelper.java 2011-08-30 14:10:58 UTC (rev 1213) @@ -39,9 +39,12 @@ /** * Class used to determine mimetype for an extension, used to determine type of - * wikittypub (data or text) with the extension and the mime type + * wikittypub (data or text) with the extension and the mime type. * + * This class is the one which handle mime type <-> file extension mapping. * + * + * * @author mfortun * */