Author: epbernard Date: 2007-09-15 14:13:35 -0400 (Sat, 15 Sep 2007) New Revision: 14011 Modified: search/trunk/src/java/org/hibernate/search/SearchFactory.java Log: Better JavaDoc Modified: search/trunk/src/java/org/hibernate/search/SearchFactory.java =================================================================== --- search/trunk/src/java/org/hibernate/search/SearchFactory.java 2007-09-14 19:32:16 UTC (rev 14010) +++ search/trunk/src/java/org/hibernate/search/SearchFactory.java 2007-09-15 18:13:35 UTC (rev 14011) @@ -16,8 +16,11 @@ ReaderProvider getReaderProvider(); /** - * Provide access to the DirectoryProvider (hence the Lucene Directory) + * Provide access to the DirectoryProviders (hence the Lucene Directories) * for a given entity + * In most cases, the returned type will be a one element array. + * But if the given entity is configured to use sharded indexes, then multiple + * elements will be returned. In this case all of them should be considered. */ DirectoryProvider[] getDirectoryProviders(Class entity);