Enunciate 1.31

Enunciate 1.31 is a patch release. It is presumably the last release of the 1.x line; development has moved to Enunciate 2.0

Enunciate 2.0 Release Candidate 1

First release candidate for Enunciate 2.0.

• Enunciate 2 Home
• Getting Started
• User Guide
• Invoking Enunciate 2
• Migrating from Enunciate 1

Enunciate 2.0 Milestone 5

Enunciate 2.0 Milestone 5 is a patch release that fixes some of the reported issues with milestone 4. Please report any other issues using the Enunciate issue tracker.

Maven

<project>
  ...
  <build>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>com.webcohesion.enunciate</groupId>
        <artifactId>enunciate-maven-plugin</artifactId>
        <version>2.0.0-M.5</version>
        <executions>
          <execution>
            <id>assemble</id>
            <goals>
              <goal>assemble</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
    ...
  </build>
  ...
</project>

Ant

<path id="enunciate.classpath">
  <fileset dir="${enunciate.home}/lib">
    <include name="*.jar"/>
  </fileset>
</path>

<taskdef name="enunciate" classname="com.webcohesion.enunciate.EnunciateTask">
  <classpath refid="enunciate.classpath"/>
</taskdef>

<enunciate basedir="src/main/java" buildDir="target/enunciate">
  <include name="**/*.java"/>
  <classpath refid="enunciate.classpath"/>
</enunciate>

Enunciate 2.0 Milestone 4

Enunciate 2.0 Milestone 4 Includes:

• All the features of 2.0 Milestone 1
• All the features of 2.0 Milestone 2
• All the features of 2.0 Milestone 3
• A bunch of bug fixes (and appreciation for those who reported them)
• Support for generating the GWT JSON Overlays
• Enabled some testing that has been disabled since the branch.

Please see the release notes for Milestone 1, Milestone 2, and Milestone 3; much of that information still applies. The examples have been updated with the new features.

It is still expected that there will be a number of bugs and other deficiencies with this release. Please report these using the Enunciate issue tracker.

Maven

<project>
  ...
  <build>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>com.webcohesion.enunciate</groupId>
        <artifactId>enunciate-maven-plugin</artifactId>
        <version>2.0.0-M.4</version>
        <executions>
          <execution>
            <id>assemble</id>
            <goals>
              <goal>assemble</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
    ...
  </build>
  ...
</project>

Ant

<path id="enunciate.classpath">
  <fileset dir="${enunciate.home}/lib">
    <include name="*.jar"/>
  </fileset>
</path>

<taskdef name="enunciate" classname="com.webcohesion.enunciate.EnunciateTask">
  <classpath refid="enunciate.classpath"/>
</taskdef>

<enunciate basedir="src/main/java" buildDir="target/enunciate">
  <include name="**/*.java"/>
  <classpath refid="enunciate.classpath"/>
</enunciate>

2.0 Milestone 3

Enunciate 2.0 Milestone 2 Includes:

• All the features of 2.0 Milestone 1
• All the features of 2.0 Milestone 2
• A bunch of bug fixes (and appreciation for those who reported them)
• Support for generating the C# XML client
• Support for generating the C/C++ XML client
• Support for generating the Objective C XML client
• Support for generating the PHP XML client
• Support for generating the PHP JSON client
• Support for generating the Ruby JSON client
• Support for including the Swagger UI
• More maven plugin enhancements:
  • Support for using Enunciate as a custom report plugin
  • Support for install and deploy client-side artifacts.
• Some smarter default settings for the generated documentation.
• Enabled some testing that has been disabled since the branch.

Please see the release notes for Milestone 1 and for Milestone 2; much of that information still applies. The examples have been updated with the new features.

It is still expected that there will be a number of bugs and other deficiencies with this release. Please report these using the Enunciate issue tracker.

Maven

<project>
  ...
  <build>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>com.webcohesion.enunciate</groupId>
        <artifactId>enunciate-maven-plugin</artifactId>
        <version>2.0.0-M.3</version>
        <executions>
          <execution>
            <id>assemble</id>
            <goals>
              <goal>assemble</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
    ...
  </build>
  ...
</project>

Ant

<path id="enunciate.classpath">
  <fileset dir="${enunciate.home}/lib">
    <include name="*.jar"/>
  </fileset>
</path>

<taskdef name="enunciate" classname="com.webcohesion.enunciate.EnunciateTask">
  <classpath refid="enunciate.classpath"/>
</taskdef>

<enunciate basedir="src/main/java" buildDir="target/enunciate">
  <include name="**/*.java"/>
  <classpath refid="enunciate.classpath"/>
</enunciate>

2.0 Milestone 2

Enunciate 2.0 Milestone 2 Includes:

• All the features of 2.0 Milestone 1
• A bunch of bug fixes (and appreciation for those who reported them)
• IDL Support (e.g. XML Schema, WSDL, WADL)
• Java XML Client Support
• Java JSON Client Support
• Support for configuring the documentation output directory in the Maven plugin.

Please see the release notes for Milestone 1; much of that information still applies. The examples
have been updated with the new features.

It is still expected that there will be a number of bugs and other deficiencies with this release. Please report these using the Enunciate issue tracker.

Maven

<project>
  ...
  <build>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>com.webcohesion.enunciate</groupId>
        <artifactId>enunciate-maven-plugin</artifactId>
        <version>2.0.0-M.2</version>
        <executions>
          <execution>
            <id>assemble</id>
            <goals>
              <goal>assemble</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
    ...
  </build>
  ...
</project>

Ant

<path id="enunciate.classpath">
  <fileset dir="${enunciate.home}/lib">
    <include name="*.jar"/>
  </fileset>
</path>

<taskdef name="enunciate" classname="com.webcohesion.enunciate.EnunciateTask">
  <classpath refid="enunciate.classpath"/>
</taskdef>

<enunciate basedir="src/main/java" buildDir="target/enunciate">
  <include name="**/*.java"/>
  <classpath refid="enunciate.classpath"/>
</enunciate>

2.0 Milestone 1

Enunciate 2.0 Milestone 1 includes:

• Support for Java 8
• Native, first-class support for JSON via Jackson annotations.
• A more modular architecture to allow for more agile extension development.
• Significant performance improvements.
• Support for the generated HTML documentation.

It is expected that there will be a number of bugs and other deficiencies with this release. Please report these using the Enunciate issue tracker.

Important note: Milestone 1 only supports the generated HTML documentation. Support for any generated client-side libraries (including Java, C#, PHP, etc.) is pending a future release.

The scope of the project has been tightened in an effort to focus on Enunciate's core functionality. Enunciate 2.0 will focus on generating documentation and client-side libraries and will no longer support runtime integration with the various frameworks. Developers using Enunciate 2.0 will need to configure their own web application according to the specifications of the framework(s) being used. Enunciate 2.0 will no longer build a .war; instead, configure Enunciate with the destination directory for the documentation and attach it to your build process.

Maven

<project>
  ...
  <build>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>com.webcohesion.enunciate</groupId>
        <artifactId>enunciate-maven-plugin</artifactId>
        <version>2.0.0-M.1</version>
        <executions>
          <execution>
            <id>assemble</id>
            <goals>
              <goal>assemble</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
    ...
  </build>
  ...
</project>

By default, the enunciate-maven-plugin will generate the documentation into the target/enunciate/docs/ directory.

Here are the plugin configuration options:

name	description
configFile	The location of the Enunciate XML configuration file. By default, Enunciate will use a file called enunciate.xml in the Maven base directory.
buildDir	The location of the directory for Enunciate's output and temporary files. Default value is ${project.build.directory}/enunciate
includes	Ant-style patterns of classes to include in the API documentation. By default, Enunciate will only include API classes that are in the current project's source tree.
excludes	Ant-style patterns of classes to exclude in the API documentation.
compilerArgs	Additional arguments to pass to the compiler that Enunciate uses to compile the API source code.
source	The value of the -source parameter used by Enunciate to compile the API source code.
target	The value of the -target parameter used by Enunciate to compile the API source code.
encoding	The value of the -encoding parameter used by Enunciate to compile the API source code.

Ant

<path id="enunciate.classpath">
  <fileset dir="${enunciate.home}/lib">
    <include name="*.jar"/>
  </fileset>
</path>

<taskdef name="enunciate" classname="com.webcohesion.enunciate.EnunciateTask">
  <classpath refid="enunciate.classpath"/>
</taskdef>

<enunciate basedir="src/main/java" buildDir="target/enunciate">
  <include name="**/*.java"/>
  <classpath refid="enunciate.classpath"/>
</enunciate>

Here are the task configuration options:

name	description
configFile	The location of the Enunciate XML configuration file.
javacArguments	Additional arguments to pass to the compiler that Enunciate uses to compile the API source code.
javacSourceVersion	The value of the -source parameter used by Enunciate to compile the API source code.
javacTargetVersion	The value of the -target parameter used by Enunciate to compile the API source code.
encoding	The value of the -encoding parameter used by Enunciate to compile the API source code.

Examples

The following examples are available to peruse as needed. These projects serve as the functional tests for the project:

• JAX-WS and JAX-RS with both XML and JSON using Jackson 1.
• JAX-RS with JSON-only using Jackson 2.

Configuration

For more information about the Enunciate configuration options, see this XML schema.

1.30

Enunciate 1.30 is a patch release. See the list of JIRA issues fixed for more information.

1.30 RC1

Patch release. See the summary of JIRA issues.

v1.28

Enunciate 1.28