Author: tmortagne
Date: 2008-01-19 22:02:25 +0100 (Sat, 19 Jan 2008)
New Revision: 6970
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java
Log:
Improve javadoc.
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java
2008-01-19 18:45:28 UTC (rev 6969)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java
2008-01-19 21:02:25 UTC (rev 6970)
@@ -235,7 +235,10 @@
}
/**
- * @return the list of documents application contains.
+ * @return the list of documents application contains. This method return
the content of the
+ * field "documents", if you want the real list of documents names
with resolved
+ * patterns and recursive tools you should use
+ * [EMAIL PROTECTED] #getDocumentsNames(boolean, boolean)}.
* @see #setDocuments(List)
*/
public List getDocuments()
@@ -256,7 +259,9 @@
/**
* @return the list of document application contains that will be included
in place of copy from
- * wiki template.
+ * wiki template. This method return the content of the field
"docstoinclude", if you
+ * want the real list of documents names with resolved patterns
and recursive tools you
+ * should use [EMAIL PROTECTED] #getDocsNameToInclude(boolean)}.
* @see #setDocsToInclude(List)
*/
public List getDocsToInclude()
@@ -279,7 +284,9 @@
/**
* @return the list of document application contains that will be linked
in place of copy from a
- * wiki template.
+ * wiki template. This method return the content of the field
"docstolink", if you want
+ * the real list of documents names with resolved patterns and
recursive tools you
+ * should use [EMAIL PROTECTED] #getDocsNameToLink(boolean)}.
* @see #setDocsToLink(List)
*/
public List getDocsToLink()
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
