r1545 - xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin

[Vincent Massol]

Author: vmassol
Date: 2006-11-14 09:50:08 +0100 (Tue, 14 Nov 2006)
New Revision: 1545

Modified:
   xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/XWikiPluginInterface.java
Log:
Added javadoc for the XWikiPluginInterface.downloadAttachment() method.

Modified: xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/XWikiPluginInterface.java
===================================================================
--- xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/XWikiPluginInterface.java	2006-11-14 08:23:15 UTC (rev 1544)
+++ xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/XWikiPluginInterface.java	2006-11-14 08:50:08 UTC (rev 1545)
@@ -55,6 +55,15 @@
     String insidePREHandler(String line, XWikiContext context);
     String endRenderingHandler(String line, XWikiContext context);
     Api getPluginApi(XWikiPluginInterface plugin, XWikiContext context);
+
+    /**
+     * Plugin extension point allowing the plugin to perform modifications to an attachement when the
+     * user clicks on an attachement in a document. The plugin is passed the original attachement and it has
+     * to return the new modified attachment.
+     *
+     * @param attachment the original attachment
+     * @param context the xwiki context object
+     * @return the modified attachment
+     */
     XWikiAttachment downloadAttachment(XWikiAttachment attachment, XWikiContext context);
-
 }