Author: tmortagne
Date: 2008-01-21 12:34:47 +0100 (Mon, 21 Jan 2008)
New Revision: 6980
Modified:
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearch.java
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearchPluginApi.java
Log:
Improve javadoc.
Modified:
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearch.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearch.java
2008-01-21 10:17:46 UTC (rev 6979)
+++
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearch.java
2008-01-21 11:34:47 UTC (rev 6980)
@@ -132,7 +132,9 @@
}
/**
- * Execute query in all provided wikis and return list containing alla
results.
+ * Execute query in all provided wikis and return list containing all
results. Compared to XWiki
+ * Platform search, searchDocuments and searchDocumentsName it's
potentially "time-consuming"
+ * since it issues one request per provided wiki.
*
* @param query the query parameters.
* @param context the XWiki context.
@@ -427,7 +429,9 @@
/**
* Search wiki pages in all provided wikis and return list containing found
- * [EMAIL PROTECTED] XWikiDocument}.
+ * [EMAIL PROTECTED] XWikiDocument}. Compared to XWiki Platform search,
searchDocuments and
+ * searchDocumentsName it's potentially "time-consuming" since it issues
one request per
+ * provided wiki.
*
* @param query the query parameters.
* @param distinctbylanguage when a document has multiple version for each
language it is
@@ -455,7 +459,9 @@
/**
* Search wiki pages in all provided wikis and return list containing found
- * [EMAIL PROTECTED] XWikiDocument}.
+ * [EMAIL PROTECTED] XWikiDocument}. Compared to XWiki Platform search,
searchDocuments and
+ * searchDocumentsName it's potentially "time-consuming" since it issues
one request per
+ * provided wiki.
*
* @param query the query parameters.
* @param distinctbylanguage when a document has multiple version for each
language it is
@@ -506,7 +512,9 @@
/**
* Search wiki pages in all provided wikis and return list containing found
- * [EMAIL PROTECTED] XWikiDocument}.
+ * [EMAIL PROTECTED] XWikiDocument}. Compared to XWiki Platform search,
searchDocuments and
+ * searchDocumentsName it's potentially "time-consuming" since it issues
one request per
+ * provided wiki.
*
* @param query the query parameters.
* @param distinctbylanguage when a document has multiple version for each
language it is
Modified:
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearchPluginApi.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearchPluginApi.java
2008-01-21 10:17:46 UTC (rev 6979)
+++
xwiki-platform/xwiki-plugins/trunk/wiki-manager/src/main/java/com/xpn/xwiki/plugin/globalsearch/GlobalSearchPluginApi.java
2008-01-21 11:34:47 UTC (rev 6980)
@@ -78,7 +78,9 @@
}
/**
- * Execute query in all provided wikis and return list containing all
results.
+ * Execute query in all provided wikis and return list containing all
results. Compared to XWiki
+ * Platform search, searchDocuments and searchDocumentsName it's
potentially "time-consuming"
+ * since it issues one request per provided wiki.
*
* @param query the query parameters. The hql has some constraints:
* <ul>
@@ -110,7 +112,9 @@
/**
* Search wiki pages in all provided wikis and return list containing found
- * [EMAIL PROTECTED] com.xpn.xwiki.api.Document}.
+ * [EMAIL PROTECTED] com.xpn.xwiki.api.Document}. Compared to XWiki
Platform search, searchDocuments and
+ * searchDocumentsName it's potentially "time-consuming" since it issues
one request per
+ * provided wiki.
*
* @param query the query parameters. The hql has some constraints:
* <ul>
@@ -147,7 +151,9 @@
/**
* Search wiki pages in all provided wikis and return list containing found
- * [EMAIL PROTECTED] com.xpn.xwiki.api.Document}.
+ * [EMAIL PROTECTED] com.xpn.xwiki.api.Document}. Compared to XWiki
Platform search, searchDocuments and
+ * searchDocumentsName it's potentially "time-consuming" since it issues
one request per
+ * provided wiki.
*
* @param query the query parameters. The hql has some constraints:
* <ul>
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
