Skip to content

Commit

Permalink
clean up errors and warnings in javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@kwsutter
kwsutter committed Oct 31, 2018
1 parent 5ab495b commit 35e2d0b
Show file tree
Hide file tree
Showing 44 changed files with 1,303 additions and 1,453 deletions.
24 changes: 12 additions & 12 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@
<groupId>jakarta.xml.registry</groupId>
<artifactId>jakarta.xml.registry-api</artifactId>
<version>1.0.9-SNAPSHOT</version>

<properties>
<non.final>false</non.final>
<extension.name>javax.xml.registry</extension.name>
<spec.version>1.0</spec.version>
<bundle.symbolicName>javax.xml.registry-api</bundle.symbolicName>
<bundle.symbolicName>javax.xml.registry-api</bundle.symbolicName>
<vendor.name>Oracle Corporation</vendor.name>
<implementation.vendor.id>org.glassfish</implementation.vendor.id>
<findbugs.version>2.3.1</findbugs.version>
Expand All @@ -42,7 +42,7 @@
</properties>
<name>jaxr-api</name>
<description>JAX R API: Eclipse Project for Stable EE4J APIs</description>
<inceptionYear>2013</inceptionYear>
<inceptionYear>2013</inceptionYear>
<url>https://github.com/eclipse-ee4jjaxr-api</url>

<developers>
Expand All @@ -53,7 +53,7 @@
<organizationUrl>http://www.oracle.com/</organizationUrl>
</developer>
</developers>

<contributors>
<contributor>
<name>Martin Grebac</name>
Expand Down Expand Up @@ -115,7 +115,7 @@
<exclude>META-INF/README</exclude>
</excludes>
</resource>
</resources>
</resources>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
Expand Down Expand Up @@ -148,7 +148,7 @@
</goals>
</execution>
</executions>
</plugin>
</plugin>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
Expand All @@ -162,7 +162,7 @@
<Bundle-SymbolicName>${spec.bundle.symbolic-name}</Bundle-SymbolicName>
<Extension-Name>${spec.extension.name}</Extension-Name>
<Implementation-Version>${spec.implementation.version}</Implementation-Version>
<Specification-Version>${spec.specification.version}</Specification-Version>
<Specification-Version>${spec.specification.version}</Specification-Version>
<Bundle-Description>
Java(TM) JAXR ${spec.version} API Design Specification
</Bundle-Description>
Expand Down Expand Up @@ -230,7 +230,7 @@
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
Expand All @@ -240,9 +240,9 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<configuration>
<!-- The following doclint line is a temporary hack to avoid javadoc errors that
<!-- The following doclint line is a temporary hack to avoid javadoc errors that
appear following jdk-8. Ultimately these warnings and errors should be resolved. -->
<additionalparam>-Xdoclint:none</additionalparam>
<!-- <additionalparam>-Xdoclint:all</additionalparam> -->
<docfilessubdirs>true</docfilessubdirs>
<groups>
<group>
Expand All @@ -259,7 +259,7 @@
</goals>
</execution>
</executions>
</plugin>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
Expand Down Expand Up @@ -296,7 +296,7 @@
<excludeFilterFile>${findbugs.exclude}</excludeFilterFile>
</configuration>
</plugin>
</plugins>
</plugins>
</reporting>
</configuration>
</plugin>
Expand Down
26 changes: 13 additions & 13 deletions src/main/java/javax/xml/registry/BulkResponse.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,41 +33,41 @@
public interface BulkResponse extends JAXRResponse {

/**
* Get the Collection of objects returned as a response of a
* Get the Collection of objects returned as a response of a
* bulk operation.
* Caller thread will block here if result is not yet available.
* Caller thread will block here if result is not yet available.
*
* <p><DL><DT><B>Capability Level: 0 </B></DL>
* <DL><DT><B>Capability Level: 0 </B></DL>
*
* @see javax.xml.registry.infomodel.RegistryObject
* @return Collection of RegistryObject instances. The Collection may be empty but not null.
* @return Collection of RegistryObject instances. The Collection may be empty but not null.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
Collection getCollection() throws JAXRException;

/**
* Get the Collection of RegistryException instances in case of partial commit.
* Caller thread will block here if result is not yet available.
/**
* Get the Collection of RegistryException instances in case of partial commit.
* Caller thread will block here if result is not yet available.
*
* <DL><DT><B>Capability Level: 0 </B></DL>
*
* <p><DL><DT><B>Capability Level: 0 </B></DL>
*
* @see RegistryException
* @return Collection of RegistryException instances. Return null if result is available and there is no RegistryException.
* @return Collection of RegistryException instances. Return null if result is available and there is no RegistryException.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
Collection getExceptions() throws JAXRException;

/**
/**
* Determines whether the response is a partial response due to large result set.
*
* <p><DL><DT><B>Capability Level: 0 </B></DL>
* <DL><DT><B>Capability Level: 0 </B></DL>
*
* @return <code>true</code> if the response is partial; <code>false</code> otherwise
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public boolean isPartialResponse() throws JAXRException;

}

0 comments on commit 35e2d0b

Please sign in to comment.