r1551 - xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer

[Vincent Massol]

Author: vmassol
Date: 2006-11-14 17:02:03 +0100 (Tue, 14 Nov 2006)
New Revision: 1551

Modified:
   xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPlugin.java
   xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPluginAPI.java
Log:
Refactoring for the ZipExplorerPlugin class and its tests:
* finished class-level javadocs


Modified: xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPlugin.java
===================================================================
--- xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPlugin.java	2006-11-14 15:44:02 UTC (rev 1550)
+++ xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPlugin.java	2006-11-14 16:02:03 UTC (rev 1551)
@@ -45,6 +45,11 @@
 
 import org.apache.commons.io.IOUtils;
 
+/**
+ * See {@link com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPluginAPI} for documentation.
+ *
+ * @version $Id: $
+ */
 public class ZipExplorerPlugin extends XWikiDefaultPlugin {
 
     /**

Modified: xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPluginAPI.java
===================================================================
--- xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPluginAPI.java	2006-11-14 15:44:02 UTC (rev 1550)
+++ xwiki/trunk/core/src/main/java/com/xpn/xwiki/plugin/zipexplorer/ZipExplorerPluginAPI.java	2006-11-14 16:02:03 UTC (rev 1551)
@@ -29,6 +29,20 @@
 import java.util.List;
 import java.util.Vector;
 
+/**
+ * ZIP-related APIs to list content of a ZIP attachments and to intercept XWiki download requests so that it's possible
+ * to display contents found inside ZIP files. This plugin accepts specially formatted URLs pointing to files inside
+ * ZIP files by using the following syntax:
+ *
+ * <code>http://[...]/download/Document/zipfile.zip/SomeDirectory/SomeFile.txt</code>.
+ *
+ * In this example, the URL points to the <code>SomeFile.txt</code> file located in a directory named
+ * <code>SomeDirectory</code> inside a ZIP file named <code>zipfile.zip</code> and attached to the document named
+ * <code>Document</code>.
+ *
+ * @version $Id: $
+ * @see com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin
+ */
 public class ZipExplorerPluginAPI extends Api {
 
     private ZipExplorerPlugin plugin;