Author: vmassol
Date: 2008-01-30 19:07:42 +0100 (Wed, 30 Jan 2008)
New Revision: 7201
Modified:
xwiki-platform/xwiki-plugins/trunk/swizzle/src/main/java/com/xpn/xwiki/plugin/swizzle/SwizzleJiraPluginApi.java
Log:
XPSWIZZLE-1: Create first implementation of a Swizzle plugin
* Added example to doc
Modified:
xwiki-platform/xwiki-plugins/trunk/swizzle/src/main/java/com/xpn/xwiki/plugin/swizzle/SwizzleJiraPluginApi.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/swizzle/src/main/java/com/xpn/xwiki/plugin/swizzle/SwizzleJiraPluginApi.java
2008-01-30 17:49:49 UTC (rev 7200)
+++
xwiki-platform/xwiki-plugins/trunk/swizzle/src/main/java/com/xpn/xwiki/plugin/swizzle/SwizzleJiraPluginApi.java
2008-01-30 18:07:42 UTC (rev 7201)
@@ -31,7 +31,19 @@
/**
* Allows getting Swizzle Objects (http://swizzle.codehaus.org/) so that it's
easy to use from a
* Velocity page in a XWiki page.
+ * <p>Example:</p>
+ * <code><pre>
+ * #set ($jira =
$xwiki.swizzle.getJira("http://jira.xwiki.org/jira/rpc/xmlrpc";))
+ * $jira.login("username", "password")
*
+ * {table}
+ * ID | Key | Project Name | Project Lead | Project URL
+ * #foreach ($project in $jira.getProjects())
+ * $project.getId() | $project.getKey() | $project.getName() |
$project.getLead() | $project.getProjectUrl()
+ * #end
+ * {table}
+ * </pre></code>
+ *
* @version $Id: $
*/
public class SwizzleJiraPluginApi extends Api
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
