Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

post release documentation fixes #16

Merged
merged 5 commits into from
Jan 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cc-xjc-dist/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<artifactId>cc-xjc-dist</artifactId>
<packaging>pom</packaging>
<name>CC-XJC Distribution</name>
<description>JAXB 2.0 Schema to Java compiler plugin binary distribution.</description>
<description>JAXB 3.0 Schema to Java compiler plugin binary distribution.</description>
<build>
<pluginManagement>
<plugins>
Expand Down
2 changes: 1 addition & 1 deletion cc-xjc-it/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<artifactId>cc-xjc-it</artifactId>
<packaging>jar</packaging>
<name>CC-XJC Test Suite</name>
<description>JAXB 2.0 Schema to Java compiler plugin test suite.</description>
<description>JAXB 3.0 Schema to Java compiler plugin test suite.</description>
<build>
<pluginManagement>
<plugins>
Expand Down
2 changes: 1 addition & 1 deletion cc-xjc-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<artifactId>cc-xjc-plugin</artifactId>
<packaging>jar</packaging>
<name>CC-XJC Plugin</name>
<description>JAXB 2.0 Schema to Java compiler plugin for adding a copy constructor to schema derived classes.</description>
<description>JAXB 3.0 Schema to Java compiler plugin for adding a copy constructor to schema derived classes.</description>
<build>
<resources>
<resource>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<packaging>pom</packaging>
<name>CC-XJC</name>
<version>3.0.1-SNAPSHOT</version>
<description>JAXB 2.0 Schema to Java compiler plugin for adding a copy constructor to schema derived classes.</description>
<description>JAXB 3.0 Schema to Java compiler plugin for adding a copy constructor to schema derived classes.</description>
<url>https://cc-xjc.wcht.de</url>
<inceptionYear>2009</inceptionYear>
<properties>
Expand Down
55 changes: 30 additions & 25 deletions src/site/apt/examples.apt
Original file line number Diff line number Diff line change
Expand Up @@ -37,52 +37,57 @@ Christian Schulte

Examples

* JAXB-RI CLI

To use the JAXB-RI XJC command line interface simply add the corresponding
java archives to the classpath and execute the XJC main class
'com.sun.tools.xjc.Driver'. The following example demonstrates a working
command line for use with JDK 1.5 (assuming the needed dependencies are
found in the current working directory).

---
java -cp activation-1.1.jar:\
jaxb-api-2.0.jar:\
stax-api-1.0.jar:\
jaxb-impl-2.0.5.jar:\
jaxb-xjc-2.0.5.jar:\
cc-xjc-plugin-2.0.jar\
com.sun.tools.xjc.Driver -d /tmp/src -copy-constructor <schema files>
---

* Maven

Maven users simply add the CC-XJC plugin as a dependency to a JAXB plugin of
choice. The following example demonstrates the use of the CC-XJC plugin with
the Mojo jaxb2-maven-plugin.
the Mojo jaxb30-maven-plugin

---
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxb2-maven-plugin</artifactId>
<version>1.3</version>
<groupId>com.evolvedbinary.maven.jvnet</groupId>
<artifactId>jaxb30-maven-plugin</artifactId>
<version>0.15.0</version>
<dependencies>
<dependency>
<groupId>de.wcht.cc-xjc</groupId>
<artifactId>cc-xjc-plugin</artifactId>
<version>2.0.2</version>
<version>3.0.0</version>
</dependency>
</dependencies>
<executions>
<execution>
<id>xjc</id>
<goals>
<goal>xjc</goal>
<goal>generate</goal>
</goals>
<configuration>
<arguments>-copy-constructor</arguments>
<args>
<arg>-copy-constructor</arg>
</args>
<schemaDirectory>src/main/schemas</schemaDirectory>
<bindingDirectory>src/main/jaxb</bindingDirectory>
<extension>true</extension>
</configuration>
</execution>
</executions>
</plugin>
---

* JAXB-RI CLI

To use the JAXB-RI XJC command line interface simply add the corresponding
java archives to the classpath and execute the XJC main class
'com.sun.tools.xjc.Driver'. The following example demonstrates a working
command line for use with JDK 1.5 (assuming the needed dependencies are
found in the current working directory).

---
java -cp activation-1.1.jar:\
jaxb-api-2.0.jar:\
stax-api-1.0.jar:\
jaxb-impl-2.0.5.jar:\
jaxb-xjc-2.0.5.jar:\
cc-xjc-plugin-2.0.jar\
com.sun.tools.xjc.Driver -d /tmp/src -copy-constructor <schema files>
---
25 changes: 14 additions & 11 deletions src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,19 @@ CC-XJC

* Introduction

CC-XJC is a JAXB 2.0 XJC plugin for adding a copy constructor to schema
CC-XJC is a JAXB 3.0 XJC plugin for adding a copy constructor to schema
derived classes. The plugin provides a '-copy-constructor' option which is
enabled by adding its jar file to the XJC classpath. When enabled, the
following options can be used to control the behavior of the plugin. See
the examples for further information.
following options can be used to control the behavior of the plugin.

See the {{{./examples.html}examples}}. for further information.

* Support

Development of CC-XJC is community driven. Please file any issues with the
{{{https://github.com/Boris-de/CC-XJC/issues}bugtracker}}.

* Features

** -cc-visibility

Expand Down Expand Up @@ -197,14 +205,9 @@ CC-XJC

* jakarta.activation.MimeType

** -cc-null-collection-elements (since ?)
** -cc-null-collection-elements (since 3.0.0)

The '-cc-null-collection-elements' option got introduced in version ?. It can
The '-cc-null-collection-elements' option got introduced in version 3.0.0. It can
be used to allow the copy of 'null'-elements contained in collections that
are copied in the constructor. Before version ? 'null'-elements would be
are copied in the constructor. Before version 3.0.0 'null'-elements would be
dropped silently when copying/cloning collections.

* Support

Development of CC-XJC is community driven. Please file any issues with the
{{{https://github.com/Boris-de/CC-XJC/issues}bugtracker}}.