Update of
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-plugin/src/test/java/org/xdoclet/plugin/plugin
In directory
sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv20773/src/test/java/org/xdoclet/plugin/plugin
Modified Files:
PluginPluginTestCase.java
Added Files:
ExamplePlugin.confluence ExamplePlugin.java
Log Message:
Improve docs generation
--- NEW FILE: ExamplePlugin.confluence ---
h2. Documentation for the ExamplePlugin plugin
Example Plugin just an example of plugin.
||Classname|org.xdoclet.plugin.plugin.ExamplePlugin|
||Maven repository|http://xdoclet-plugins.sourceforge.net/repository|
||Property||Required||Allowed values||Default value||Description||
|anotherProperty |false |defeat, victory |victory |This property should appear
in generated documentation. |
|cheese |true |brie, stilton |brie |Sets the cheese. |
--- NEW FILE: ExamplePlugin.java ---
/*
* Copyright (c) 2003
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.plugin;
import java.io.File;
import org.generama.QDoxCapableMetadataProvider;
import org.generama.TemplateEngine;
import org.generama.WriterMapper;
import org.generama.defaults.QDoxPlugin;
/**
* Example Plugin just an example of plugin.
*
* @author Anatol Pomozov
*/
public class ExamplePlugin extends QDoxPlugin {
public ExamplePlugin(TemplateEngine templateEngine,
QDoxCapableMetadataProvider qDoxCapableMetadataProvider,
WriterMapper writerMapper) {
super(templateEngine, qDoxCapableMetadataProvider, writerMapper);
}
/**
* This property should appear in generated documentation.
*
* @generama.property required="false" default="victory"
allowed-values="defeat, victory"
*/
public void setAnotherProperty(File s) {
}
/**
* Sets the cheese.
*
* @generama.property required="true" default="brie" allowed-values="brie,
stilton"
*/
public void setCheese(String s) {
}
public void setSkip(Integer skipit) {
}
}
Index: PluginPluginTestCase.java
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-plugin/src/test/java/org/xdoclet/plugin/plugin/PluginPluginTestCase.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** PluginPluginTestCase.java 18 Jun 2004 16:37:52 -0000 1.7
--- PluginPluginTestCase.java 31 May 2005 11:28:18 -0000 1.8
***************
*** 1,30 ****
package org.xdoclet.plugin.plugin;
import org.generama.MetadataProvider;
import org.generama.Plugin;
import org.generama.VelocityTemplateEngine;
import org.generama.WriterMapper;
import org.generama.tests.AbstractTextGeneratingPluginTestCase;
- import org.xdoclet.QDoxMetadataProvider;
! import java.io.File;
! import java.io.IOException;
! import java.net.URL;
public class PluginPluginTestCase extends
AbstractTextGeneratingPluginTestCase {
! protected Plugin createPlugin(MetadataProvider metadataProvider,
WriterMapper writerMapper) throws Exception {
! return new PluginPlugin(new VelocityTemplateEngine(),
(QDoxMetadataProvider) metadataProvider, writerMapper);
}
protected MetadataProvider createMetadataProvider() throws IOException {
! String basedir = System.getProperty("xdoclet.plugin.home");
! assertNotNull(basedir);
! URL reader = new File(basedir +
"/src/main/java/org/xdoclet/plugin/plugin/PluginPlugin.java").toURL();
return new QDoxMetadataProvider(reader);
}
! protected URL getExpected() throws IOException {
! return
getResourceRelativeToThisPackage("expected/PluginPlugin.confluence");
}
!
! }
--- 1,35 ----
+ /*
+ * Copyright (c) 2003
+ * XDoclet Team
+ * All rights reserved.
+ */
package org.xdoclet.plugin.plugin;
+ import java.io.IOException;
+
+ import java.net.URL;
+
import org.generama.MetadataProvider;
import org.generama.Plugin;
import org.generama.VelocityTemplateEngine;
import org.generama.WriterMapper;
+
import org.generama.tests.AbstractTextGeneratingPluginTestCase;
! import org.xdoclet.QDoxMetadataProvider;
public class PluginPluginTestCase extends
AbstractTextGeneratingPluginTestCase {
! protected URL getExpected() throws IOException {
! return getResourceRelativeToThisPackage("ExamplePlugin.confluence");
}
protected MetadataProvider createMetadataProvider() throws IOException {
! URL reader = getResourceRelativeToThisPackage("ExamplePlugin.java");
return new QDoxMetadataProvider(reader);
}
! protected Plugin createPlugin(MetadataProvider metadataProvider,
WriterMapper writerMapper)
! throws Exception {
! return new PluginPlugin(new VelocityTemplateEngine(),
(QDoxMetadataProvider) metadataProvider, writerMapper);
}
! }
\ No newline at end of file
-------------------------------------------------------
This SF.Net email is sponsored by Yahoo.
Introducing Yahoo! Search Developer Network - Create apps using Yahoo!
Search APIs Find out how you can build Yahoo! directly into your own
Applications - visit http://developer.yahoo.net/?fr=offad-ysdn-ostg-q22005
_______________________________________________
xdoclet-plugins-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-commits
