Bommels05/maven-plugins
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

moved to sandbox

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@190738 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
brett committed 2005-06-15 12:00:30 +00:00
1 parent 2643ee2461
commit f183b572da
10 files changed
-587
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

vdoclet/plugin.jelly
-42
View File
@@ -1,42 +0,0 @@
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<project
xmlns:j="jelly:core"
xmlns:define="jelly:define"
xmlns:vdoclet="vdoclet">
<define:taglib uri="vdoclet">
<define:jellybean
name="vdocletBean"
className="org.apache.maven.vdoclet.VDocletBean"
method="execute">
</define:jellybean>
<define:tag name="vdoclet">
<vdoclet:vdocletBean
srcDir="${srcDir}"
destDir="${destDir}"
template="${template}"
outputFile="${outputFile}"
encoding="${encoding}"
jellyContext="${context}"
/>
</define:tag>
</define:taglib>
</project>
vdoclet/plugin.properties
-26
View File
@@ -1,26 +0,0 @@
# -------------------------------------------------------------------
# Copyright 2001-2004 The Apache Software Foundation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -------------------------------------------------------------------
# -------------------------------------------------------------------
# Default Maven properties for the VDoclet plugin.
# -------------------------------------------------------------------
# These are the properties that we believe are immutable so we
# keep them apart from the project specific properties.
# -------------------------------------------------------------------
maven.vdoclet.srcDir = NOT_SET
maven.vdoclet.destDir = NOT_SET
maven.vdoclet.template = NOT_SET
vdoclet/project.properties
-19
View File
@@ -1,19 +0,0 @@
# -------------------------------------------------------------------
# Copyright 2001-2004 The Apache Software Foundation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -------------------------------------------------------------------
# -------------------------------------------------------------------
# P R O J E C T P R O P E R T I E S
# -------------------------------------------------------------------
vdoclet/project.xml
-114
View File
@@ -1,114 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<project>
<extend>../plugin-parent/project.xml</extend>
<pomVersion>3</pomVersion>
<id>maven-vdoclet-plugin</id>
<name>Maven VDoclet Plug-in</name>
<currentVersion>1.2.1-SNAPSHOT</currentVersion>
<description>VDoclet plugin for Maven. Allows you to easily create information from source code using velocity driven templates</description>
<shortDescription>VDoclet plugin for Maven</shortDescription>
<url>http://maven.apache.org/reference/plugins/vdoclet/</url>
<issueTrackingUrl>http://jira.codehaus.org/browse/MPVDOCLET</issueTrackingUrl>
<siteDirectory>/www/maven.apache.org/reference/plugins/vdoclet/</siteDirectory>
<repository>
<connection>scm:svn:http://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk/vdoclet/</connection>
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk/vdoclet/</developerConnection>
<url>http://svn.apache.org/viewcvs.cgi/maven/maven-1/plugins/trunk/vdoclet/</url>
</repository>
<versions>
<version>
<id>1.1</id>
<name>1.1</name>
<tag>MAVEN_VDOCLET_1_1</tag>
</version>
<version>
<id>1.2</id>
<name>1.2</name>
<tag>MAVEN_VDOCLET_1_2</tag>
</version>
</versions>
<developers>
<developer>
<name>Jason van Zyl</name>
<id>jvanzyl</id>
<email>jason@zenplex.com</email>
<organization>Zenplex</organization>
<roles>
<role>Architect</role>
<role>Release Manager</role>
</roles>
</developer>
<developer>
<name>Pete Kazmier</name>
<id>kaz</id>
<email>pete-apache-dev@kazmier.com</email>
<organization/>
<roles>
<role>Developer</role>
</roles>
</developer>
</developers>
<dependencies>
<dependency>
<groupId>vdoclet</groupId>
<artifactId>vdoclet</artifactId>
<version>20020711</version>
</dependency>
<dependency>
<groupId>velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.4-dev</version>
</dependency>
<dependency>
<groupId>vdoclet</groupId>
<artifactId>qdox</artifactId>
<version>current</version>
</dependency>
<dependency>
<groupId>commons-collections</groupId>
<artifactId>commons-collections</artifactId>
<version>2.1</version>
</dependency>
<dependency>
<groupId>oro</groupId>
<artifactId>oro</artifactId>
<version>2.0.7</version>
</dependency>
<dependency>
<groupId>commons-jelly</groupId>
<artifactId>commons-jelly</artifactId>
<version>1.0-beta-4</version>
<url>http://jakarta.apache.org/commons/jelly/</url>
</dependency>
<dependency>
<groupId>commons-jelly</groupId>
<artifactId>commons-jelly-tags-velocity</artifactId>
<version>1.0</version>
<url>http://jakarta.apache.org/commons/jelly/</url>
</dependency>
<dependency>
<groupId>logkit</groupId>
<artifactId>logkit</artifactId>
<version>1.0.1</version>
</dependency>
</dependencies>
</project>
vdoclet/src/main/org/apache/maven/vdoclet/VDocletBean.java
-186
View File
@@ -1,186 +0,0 @@
package org.apache.maven.vdoclet;
/* ====================================================================
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ====================================================================
*/
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import org.apache.commons.jelly.JellyContext;
import org.apache.commons.jelly.tags.velocity.JellyContextAdapter;
import org.apache.velocity.context.Context;
import com.thoughtworks.qdox.model.JavaSource;
import vdoclet.Generator;
import vdoclet.docinfo.DocInfo;
import vdoclet.docinfo.QDoxBuilder;
/**
* Command-line entry-point to vDoclet
*/
public class VDocletBean
{
/** output directory */
File srcDir;
/** output directory */
File destDir;
/** output directory */
String outputFile;
/** control template */
String template;
/** encoding */
String encoding;
/** verbose flag */
boolean verbose = false;
/** docinfo */
DocInfo docInfo;
/** The jelly context */
JellyContext jellyContext;
/**
* Alias for srcPath
*/
public void setSrcDir(File srcDir)
{
this.srcDir = srcDir;
}
/**
* destDir attribute
*/
public void setDestDir(File destDir)
{
this.destDir = destDir;
}
/**
* Set the Jelly context.
*
* @param jellyContext the Jelly context
*/
public void setJellyContext(JellyContext jellyContext)
{
this.jellyContext = jellyContext;
}
/**
* destDir attribute
*/
public void setOutputFile(String outputFile)
{
this.outputFile = outputFile;
}
/**
* template attribute
*/
public void setTemplate(String template)
{
this.template = template;
}
/**
* encoding attribute
*/
public void setEncoding(String encoding)
{
this.encoding = encoding;
}
/**
* Description of the Method
*/
public void execute()
throws Exception
{
parseSources();
generate();
}
/**
* Description of the Method
*/
void log(String msg)
{
if (verbose)
{
System.err.println(msg);
}
}
/**
* Parse the source-files
*/
void parseSources()
throws IOException
{
com.thoughtworks.qdox.JavaDocBuilder builder =
new com.thoughtworks.qdox.JavaDocBuilder();
builder.addSourceTree(srcDir);
JavaSource[] javaSources = builder.getSources();
log(javaSources.length + " source-files");
docInfo = QDoxBuilder.build(javaSources);
docInfo.setSourcePath(srcDir.getAbsolutePath());
}
/**
* Kick-start generation
*/
void generate()
throws Exception
{
if (!destDir.exists())
{
destDir.mkdirs();
}
Generator generator = new Generator(destDir);
generator.setAttribute("docInfo", docInfo);
if (jellyContext != null)
{
generator.setAttribute("jellyContext", getJellyContextAdapter());
}
if (encoding != null)
{
generator.setAttribute("encoding", encoding);
}
generator.eval(template, new FileWriter(new File(destDir, outputFile)));
}
private Context getJellyContextAdapter()
{
JellyContextAdapter adapter = new JellyContextAdapter(jellyContext);
adapter.setReadOnly(true);
return adapter;
}
}
vdoclet/xdocs/changes.xml
-42
View File
@@ -1,42 +0,0 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Changes</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
</properties>
<body>
<release version="1.1" date="2003-09-29">
<action dev="dion" type="update">update to commons-jelly-20030902.160215</action>
<action dev="dion" type="update">Move to oro 2.0.7</action>
<action dev="dion" type="fix">
Regen plugin docs, fix various project.xml issues.
</action>
</release>
<release version="1.0" date="2002-08-04">
<action dev="jvanzyl" type="add">
Original release for Maven 1.0-beta8
</action>
</release>
</body>
</document>
vdoclet/xdocs/goals.xml
-30
View File
@@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven VDoclet Plug-in Goals</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<goals>
</goals>
</body>
</document>
vdoclet/xdocs/index.xml
-33
View File
@@ -1,33 +0,0 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven VDoclet Plug-in</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
</properties>
<body>
<section name="Maven VDoclet Plug-in">
<p>
</p>
</section>
</body>
</document>
vdoclet/xdocs/navigation.xml
-34
View File
@@ -1,34 +0,0 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<project name="Maven VDoclet Plugin">
<title>Maven VDoclet Plugin</title>
<body>
<links>
<item name="Maven" href="http://maven.apache.org/"/>
<item name="VDoclet" href="http://vdoclet.sourceforge.net/"/>
</links>
<menu name="Overview">
<item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
</menu>
</body>
</project>
vdoclet/xdocs/properties.xml
-61
View File
@@ -1,61 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven VDoclet Plug-in Properties</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="Maven VDoclet Plug-in Settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.vdoclet.template</td>
<td>Yes</td>
<td>
<p>Default value is
<code>NOT_SET</code>.</p>
</td>
</tr>
<tr>
<td>maven.vdoclet.srcDir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>NOT_SET</code>.</p>
</td>
</tr>
<tr>
<td>maven.vdoclet.destDir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>NOT_SET</code>.</p>
</td>
</tr>
</table>
</section>
</body>
</document>