- Revision
- 612
- Author
- paul
- Date
- 2009-06-23 20:59:33 -0500 (Tue, 23 Jun 2009)
Log Message
blackbelt mvn fu from Robert Scholte, for xsite + maven-gen'd-docs
Modified Paths
Added Paths
Diff
Modified: trunk/qdox/pom.xml (611 => 612)
--- trunk/qdox/pom.xml 2009-06-23 21:01:09 UTC (rev 611) +++ trunk/qdox/pom.xml 2009-06-24 01:59:33 UTC (rev 612) @@ -19,6 +19,23 @@ <distribution>repo</distribution> </license> </licenses> + + <mailingLists> + <mailingList> + <name>announce at QDox</name> + <post>[email protected]</post> + <subscribe>http://xircles.codehaus.org/lists/[email protected]/subscribe</subscribe> + <unsubscribe>http://xircles.codehaus.org/lists/[email protected]/unsubscribe</unsubscribe> + <archive>http://archive.codehaus.org/lists/org.codehaus.qdox.announce</archive> + </mailingList> + <mailingList> + <name>dev at QDox</name> + <post>[email protected]</post> + <subscribe>http://xircles.codehaus.org/lists/[email protected]/subscribe</subscribe> + <unsubscribe>http://xircles.codehaus.org/lists/[email protected]/unsubscribe</unsubscribe> + <archive>http://archive.codehaus.org/lists/org.codehaus.qdox.dev</archive> + </mailingList> + </mailingLists> <issueManagement> <system>jira</system> @@ -234,25 +251,71 @@ </executions> </plugin> <plugin> + <artifactId>maven-site-plugin</artifactId> + <version>2.0</version> + <configuration> + <templateFile>${basedir}/src/site/templates/site-template.vm</templateFile> + </configuration> + </plugin> + <plugin> <groupId>org.codehaus.xsite</groupId> <artifactId>xsite-maven-plugin</artifactId> <version>1.0</version> <configuration> <sitemapPath>content/website.xml</sitemapPath> <skinPath>templates/skin.html</skinPath> - <sourceDirectoryPath>${basedir}/src/site</sourceDirectoryPath> + <sourceDirectoryPath>${xsite.sourceDirectoryPath}</sourceDirectoryPath> <outputDirectoryPath>${project.build.directory}/site</outputDirectoryPath> <resourcePaths>resources</resourcePaths> </configuration> <executions> <execution> - <phase>install</phase> + <phase>site</phase> <goals> <goal>run</goal> </goals> </execution> </executions> </plugin> + <plugin> + <artifactId>maven-resources-plugin</artifactId> + <executions> + <execution> + <id>pre-copy-resources</id> + <phase>pre-site</phase> + <goals> + <goal>copy-resources</goal> + </goals> + <configuration> + <outputDirectory>${xsite.sourceDirectoryPath}</outputDirectory> + <resources> + <resource> + <directory>src/site</directory> + </resource> + </resources> + </configuration> + </execution> + <execution> + <id>post-copy-resources</id> + <phase>site</phase> + <goals> + <goal>copy-resources</goal> + </goals> + <configuration> + <outputDirectory>${project.build.directory}/site</outputDirectory> + <resources> + <resource> + <directory>${xsite.sourceDirectoryPath}/content</directory> + <includes> + <include>images/*.*</include> + <include>apidocs/**/*.*</include> + </includes> + </resource> + </resources> + </configuration> + </execution> + </executions> + </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-release-plugin</artifactId> @@ -370,6 +433,7 @@ <!-- Reports --> <reporting> + <outputDirectory>${xsite.sourceDirectoryPath}/content</outputDirectory> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> @@ -384,6 +448,7 @@ <report>issue-tracking</report> <report>license</report> <report>scm</report> + <report>summary</report> </reports> </reportSet> </reportSets> @@ -426,5 +491,7 @@ </plugin> </plugins> </reporting> - + <properties> + <xsite.sourceDirectoryPath>${project.build.directory}/generated-site</xsite.sourceDirectoryPath> + </properties> </project> \ No newline at end of file
Modified: trunk/qdox/src/site/content/website.xml (611 => 612)
--- trunk/qdox/src/site/content/website.xml 2009-06-23 21:01:09 UTC (rev 611) +++ trunk/qdox/src/site/content/website.xml 2009-06-24 01:59:33 UTC (rev 612) @@ -5,16 +5,33 @@ </section> <section> <name>Evaluating QDox</name> - <page>license.html</page> <page>download.html</page> <page>changes.html</page> <page>upgrade.html</page> <page>whouses.html</page> </section> + <section> + <name>Project Information</name> + <page>dependencies.html</page> + <page>issue-tracking.html</page> + <page>mail-lists.html</page> + <page>license.html</page> + <page>project-summary.html</page> + <page>team-list.html</page> + <page>source-repository.html</page> + </section> + <section> + <name>Project Reports</name> + <page>changes-report.html</page> + <link title="javadoc">http://qdox.codehaus.org/apidocs/index.html</link> + <page>usage.html</page> + </section> + <section> <name>Using QDox</name> <page>usage.html</page> <page>model.html</page> - <link title="JavaDoc">javadoc/index.html</link> +<!-- <link title="JavaDoc">javadoc/index.html</link>--> +<!-- <page>model.html</page>--> </section> </sitemap>
Modified: trunk/qdox/src/site/content/whouses.html (611 => 612)
--- trunk/qdox/src/site/content/whouses.html 2009-06-23 21:01:09 UTC (rev 611) +++ trunk/qdox/src/site/content/whouses.html 2009-06-24 01:59:33 UTC (rev 612) @@ -12,136 +12,147 @@ </tr> <tr> - <td><nobr><a href="" Attributes</a></nobr></td> + <td><nobr><a href="" <td> - Jakarta Commons Attributes provides an API to runtime metadata attributes. Attributes are specified as doclet tags and then compiled into the classpath where they can be accessed at runtime (without requiring the source). The aim is to provide a framework similar to .NET attributes. + AspectWerkz is an Aspect Oriented Programming (AOP) toolkit for Java that modifies byte-code to + weave in interceptors and mixins. </td> <td> - QDox is used to extract the JavaDoc tags from the source files. + Attributes can be used to associate interceptors and mixins with a specific class. </td> </tr> - + <tr> - <td><nobr><a href="" Maker</a></nobr></td> + <td><nobr><a href="" Phoenix</a></nobr></td> <td> - Mock Maker is a tool for automatically generating mock objects from custom classes to aid in testing the - untestable. This supports the practises of Test Driven Development and eXtreme Programming. + Phoenix was a micro-kernel designed and implemented on top of the Avalon framework. It provided a number + of facilities to manage the environment of Server Applications. Apache cancelled the Avalon project 2004 </td> <td> - Mock Maker scans the source repository for any class/interface marked with the @mock JavaDoc tag - and automatically creates the Mock Object for this that matches the class definition. + 'MetaGenerate' is part of the Phoenix toolset and picks up @phoenix prefixed JavaDoc tags + to make XML manifests for the components that will be laced together in more XML to make + a complete server application. </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" <td> - vDoclet is a framework for code-generation using Velocity templates, - based on annotated Java source-code. + Apache Cocoon is an XML publishing framework that raises the usage of XML and XSLT technologies for server applications + to a new level. Designed for performance and scalability around pipelined SAX processing, Cocoon offers a flexible + environment based on a separation of concerns between content, logic, and style. </td> <td> - vDoclet uses QDox to produce input-data for it's templates. + The QDox Block reads in Java source files and fires out SAX events enabling processing by standard XML tools (such as XSLT). </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" Attributes</a></nobr></td> <td> - XDoclet2 is a framework for code-generation using Velocity or Jelly templates, - based on annotated Java source-code. It is a rewrite of XDoclet. + Jakarta Commons Attributes provides an API to runtime metadata attributes. Attributes are specified as doclet tags and then compiled into the classpath where they can be accessed at runtime (without requiring the source). The aim is to provide a framework similar to .NET attributes. </td> <td> - XDoclet2 uses QDox to produce input-data for it's templates, as well as - QDox' APITestCase to validate the generated sources. + QDox is used to extract the JavaDoc tags from the source files. </td> </tr> - + <tr> - <td><nobr><a href="" + <td><nobr><a href="" <td> - Nanning is an Aspect Oriented Programming (AOP) toolkit for Java that does not require - a custom compiler. It uses dynamic proxies to weave in interceptors and mixins at runtime. + Ivory provides easy integration between your exiting Java classes, Avalon services, and Axis. + It allows easy deployment of soap services with none of the WSDD configuration that Axis normally mandates. </td> <td> - QDox is used to allow aspects to be applied to classes by specifiying meta-data in doclet tags. + Attributes are used to provide additional hints to Ivory about Java classes that cannot be determined via reflection. </td> </tr> - + <tr> - <td><nobr><a href="" Phoenix</a></nobr></td> + <td><nobr><a href="" <td> - Phoenix was a micro-kernel designed and implemented on top of the Avalon framework. It provided a number - of facilities to manage the environment of Server Applications. Apache cancelled the Avalon project 2004 + The Javadoc Plugin uses the Javadoc tool to generate javadocs for the specified project. </td> <td> - 'MetaGenerate' is part of the Phoenix toolset and picks up @phoenix prefixed JavaDoc tags - to make XML manifests for the components that will be laced together in more XML to make - a complete server application. + When developers write code, they could forget to create (or update) the Javadoc comments. The <fix> and <test-fix> + goals are interactive goals to fix the actual Javadoc comments. </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" 2</a></nobr></td> <td> - Ivory provides easy integration between your exiting Java classes, Avalon services, and Axis. - It allows easy deployment of soap services with none of the WSDD configuration that Axis normally mandates. + Maven is a software project management and comprehension tool. </td> <td> - Attributes are used to provide additional hints to Ivory about Java classes that cannot be determined via reflection. + QDox is used for extraction of Javadoc tags from source files to generate plugin descriptors </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" Maker</a></nobr></td> <td> - Voruta is a data access framework for embedding SQL statements in Java methods using custom JavaDoc - tags and dynamic code generation at runtime. + Mock Maker is a tool for automatically generating mock objects from custom classes to aid in testing the + untestable. This supports the practises of Test Driven Development and eXtreme Programming. </td> <td> - QDox is used to parse metadata and CGLib to generate implementation at runtime. + Mock Maker scans the source repository for any class/interface marked with the @mock JavaDoc tag + and automatically creates the Mock Object for this that matches the class definition. </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" <td> - AspectWerkz is an Aspect Oriented Programming (AOP) toolkit for Java that modifies byte-code to - weave in interceptors and mixins. + Nanning is an Aspect Oriented Programming (AOP) toolkit for Java that does not require + a custom compiler. It uses dynamic proxies to weave in interceptors and mixins at runtime. </td> <td> - Attributes can be used to associate interceptors and mixins with a specific class. + QDox is used to allow aspects to be applied to classes by specifiying meta-data in doclet tags. </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" <td> - Apache Cocoon is an XML publishing framework that raises the usage of XML and XSLT technologies for server applications - to a new level. Designed for performance and scalability around pipelined SAX processing, Cocoon offers a flexible - environment based on a separation of concerns between content, logic, and style. + Paranamer a mechamism for accessing the parameter names of methods of Java classes compiled into jars </td> <td> - The QDox Block reads in Java source files and fires out SAX events enabling processing by standard XML tools (such as XSLT). + QDox is used to parse the source and generate the parameter names list. </td> </tr> <tr> - <td><nobr><a href="" + <td><nobr><a href="" <td> - Paranamer a mechamism for accessing the parameter names of methods of Java classes compiled into jars + vDoclet is a framework for code-generation using Velocity templates, + based on annotated Java source-code. </td> <td> - QDox is used to parse the source and generate the parameter names list. + vDoclet uses QDox to produce input-data for it's templates. </td> </tr> + + <tr> + <td><nobr><a href="" + <td> + Voruta is a data access framework for embedding SQL statements in Java methods using custom JavaDoc + tags and dynamic code generation at runtime. + </td> + <td> + QDox is used to parse metadata and CGLib to generate implementation at runtime. + </td> + </tr> <tr> - <td><nobr><a href="" 2</a></nobr></td> + <td><nobr><a href="" <td> - Maven is a software project management and comprehension tool. + XDoclet2 is a framework for code-generation using Velocity or Jelly templates, + based on annotated Java source-code. It is a rewrite of XDoclet. </td> <td> - QDox is used for extraction of Javadoc tags from source files to generate plugin descriptors + XDoclet2 uses QDox to produce input-data for it's templates, as well as + QDox' APITestCase to validate the generated sources. </td> </tr>
Added: trunk/qdox/src/site/templates/site-template.vm (0 => 612)
--- trunk/qdox/src/site/templates/site-template.vm (rev 0) +++ trunk/qdox/src/site/templates/site-template.vm 2009-06-24 01:59:33 UTC (rev 612) @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title>#if($title.startsWith('QDox - ')) $title.substring(6) #else $title #end</title> + <style type="text/css" media="all"> + @import url("$relativePath/css/maven-base.css"); + @import url("$relativePath/css/maven-theme.css"); + @import url("$relativePath/css/site.css"); + </style> + </head> + <body> + $bodyContent + </body> +</html> +
To unsubscribe from this list please visit:
