[hibernate-commits] Hibernate SVN: r15625 - search/trunk/src/java/org/hibernate/search/annotations.

Author: hardy.ferentschik Date: 2008-11-27 08:32:12 -0500 (Thu, 27 Nov 2008) New Revision: 15625 Modified: search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java Log: Javadoc Modified: search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java =================================================================== --- search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java 2008-11-27 13:12:23 UTC (rev 15624) +++ search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java 2008-11-27 13:32:12 UTC (rev 15625) @@ -19,22 +19,25 @@ @Documented public @interface FullTextFilterDef { /** - * Filter name. Must be unique across all mappings for a given persistence unit + * @return the filter name. Must be unique across all mappings for a given persistence unit */ String name(); /** - * Either implements org.apache.lucene.search.Filter - * or contains a @Factory method returning one. - * The Filter generated must be thread-safe + * Either implements {@link org.apache.lucene.search.Filter} + * or contains a <code>@Factory</code> method returning one. + * The generated <code>Filter</code> must be thread-safe. * - * If the filter accept parameters, an @Key method must be present as well + * If the filter accept parameters, an <code>@Key</code> method must be present as well. * + * @return a class which either implements <code>Filter</code> directly or contains a method annotated with + * <code>@Factory</code>. + * */ Class<?> impl(); /** - * Cache mode for the filter. Default to instance and results caching + * @return The cache mode for the filter. Default to instance and results caching */ FilterCacheModeType cache() default FilterCacheModeType.INSTANCE_AND_DOCIDSETRESULTS; }