Author: bleny Date: 2010-08-03 11:48:17 +0200 (Tue, 03 Aug 2010) New Revision: 217 Url: http://nuiton.org/repositories/revision/wikitty/217 Log: a bit of javadoc Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/FieldType.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittySearchEngin.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/FieldType.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/FieldType.java 2010-08-03 09:29:14 UTC (rev 216) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/FieldType.java 2010-08-03 09:48:17 UTC (rev 217) @@ -145,7 +145,7 @@ result = WikittyUtil.toString(value); break; default: // if type is not found then type is business type - // and is wikity object + // and is wikitty object result = WikittyUtil.toWikitty(value); break; } return result; Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java 2010-08-03 09:29:14 UTC (rev 216) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java 2010-08-03 09:48:17 UTC (rev 217) @@ -244,7 +244,7 @@ /** * Search object that correspond to criteria and that have all extension * needed by BusinessEntity (clazz). If criteria is null, find all extensions - * else if crtiteria is empty return nothing. + * else if criteria is empty return nothing. * * @param <E> object type * @param clazz entity class Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittySearchEngin.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittySearchEngin.java 2010-08-03 09:29:14 UTC (rev 216) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittySearchEngin.java 2010-08-03 09:48:17 UTC (rev 217) @@ -21,7 +21,7 @@ import java.util.Map; /** - * WikittySearchEngin is used to abstract search engin used in WikittyService. + * WikittySearchEngin is used to abstract search engine used in WikittyService. * * * @author poussin Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java 2010-08-03 09:29:14 UTC (rev 216) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java 2010-08-03 09:48:17 UTC (rev 217) @@ -24,6 +24,20 @@ /** * Wikitty service. + * + * The main implementation for this interface is {@link WikittyServiceImpl}. + * It can be used alone but this implementation doesn't deal with all + * stuffs described in this interface. Thus, other functionalities are added + * to the implementation through objects that decorate WikittyServiceImpl : + * + * <dl> + * <dt>{@link WikittyServiceCached}</dt> + * <dd>add a cache for wikitties</dd> + * <dt>{@link WikittyServiceSecurity}</dt> + * <dd>add user authentication support and right management</dd> + * <dt>{@link WikittyServiceNotifier}</dt> + * <dd>add notifications between client of the same wikitty service</dd> + * </dl> * * @author poussin * @version $Revision$