Author: challngr Date: Thu May 23 18:36:22 2013 New Revision: 1485814 URL: http://svn.apache.org/r1485814 Log: UIMA-2682 Update master POM to better select javadocable classes. Update assembly script to plop javadoc into ws root. Clean up javadoc errors.
Modified: uima/sandbox/uima-ducc/trunk/pom.xml uima/sandbox/uima-ducc/trunk/src/main/assembly/bin.xml uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceApi.java uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/AServicePing.java uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/ServiceStatistics.java Modified: uima/sandbox/uima-ducc/trunk/pom.xml URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/pom.xml?rev=1485814&r1=1485813&r2=1485814&view=diff ============================================================================== --- uima/sandbox/uima-ducc/trunk/pom.xml (original) +++ uima/sandbox/uima-ducc/trunk/pom.xml Thu May 23 18:36:22 2013 @@ -147,18 +147,25 @@ <packages>*</packages> </group> </groups> + <stylesheet> + maven + </stylesheet> + <!--verbose>true</verbose --> <sourcepath> uima-ducc-common/src/main/java:uima-ducc-cli/src/main/java </sourcepath> + <subpackages>org.apache.uima</subpackages> - <!-- excludePackageNames></excludePackageNames --> + + <excludePackageNames> + org.apache.uima.ducc.cli.*:org.apache.uima.ducc.common.* + </excludePackageNames> + <!-- add a few classes in impl packages that are directly used by user code --> <additionalparam> - - ${basedir}/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/AServicePing.java ${basedir}/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/ServiceStatistics.java @@ -180,11 +187,8 @@ ${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IDuccMonitor.java ${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IServiceApi.java - - - - </additionalparam> + <!-- Link these to the uimaj javadocs on apache.org --> <!-- links> <link>http://uima.apache.org/d/uimaj-${uimajDependencyVersion}/apidocs</link> Modified: uima/sandbox/uima-ducc/trunk/src/main/assembly/bin.xml URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/src/main/assembly/bin.xml?rev=1485814&r1=1485813&r2=1485814&view=diff ============================================================================== --- uima/sandbox/uima-ducc/trunk/src/main/assembly/bin.xml (original) +++ uima/sandbox/uima-ducc/trunk/src/main/assembly/bin.xml Thu May 23 18:36:22 2013 @@ -490,6 +490,14 @@ under the License. <include>*.jpg</include> </includes> </fileSet> + + <fileSet> + <!-- add javadocs to the webserver directory --> + <directory>target/site</directory> + <outputDirectory>ducc_runtime/webserver/root/doc</outputDirectory> + <fileMode>644</fileMode> + <directoryMode>755</directoryMode> + </fileSet> </fileSets> <files> Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceApi.java URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceApi.java?rev=1485814&r1=1485813&r2=1485814&view=diff ============================================================================== --- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceApi.java (original) +++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceApi.java Thu May 23 18:36:22 2013 @@ -126,6 +126,9 @@ public class DuccServiceApi }; + /** + * Service start arguments. + */ UiOption[] start_options = { UiOption.Help, UiOption.Debug, @@ -263,8 +266,8 @@ public class DuccServiceApi } /** - * @param props Name of file in standard Java properies format with the service specification. - * @return + * @param args Name of file in standard Java properies format with the service specification. + * @return Reply object with the registration numeric id and errors, if any. */ public IServiceReply register(String[] args) throws Exception @@ -373,8 +376,8 @@ public class DuccServiceApi } /** - * @param id The full service id as returned by register - * @return + * @param args The full service id as returned by register + * @return Reply object with unregister status. */ public IServiceReply unregister(String[] args) throws Exception @@ -397,8 +400,8 @@ public class DuccServiceApi } /** - * @param props Name of file in standard Java properies format with the service specification. - * @return + * @param args Service start arguments. + * @return Reply object with start status. */ public IServiceReply start(String[] args) throws Exception @@ -427,8 +430,8 @@ public class DuccServiceApi /** - * @param props Name of file in standard Java properies format with the service specification. - * @return + * @param args Stop arguments. + * @return Reply object with stop status. */ public IServiceReply stop(String[] args) throws Exception @@ -456,7 +459,8 @@ public class DuccServiceApi } /** - * @return + * @param args Modify arguments. + * @return Reply object with modify status. */ public IServiceReply modify(String[] args) throws Exception @@ -485,8 +489,8 @@ public class DuccServiceApi } /** - * @param props Name of file in standard Java properies format with the service specification. - * @return + * @param args Query arguments. + * @return Reply object with the query results. */ public IServiceReply query(String[] args) throws Exception Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/AServicePing.java URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/AServicePing.java?rev=1485814&r1=1485813&r2=1485814&view=diff ============================================================================== --- uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/AServicePing.java (original) +++ uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/AServicePing.java Thu May 23 18:36:22 2013 @@ -35,7 +35,7 @@ public abstract class AServicePing /** * Returns the object with application-derived health and statistics. - * @return {@link ServiceStatistcs} This object contains the informaton the service manager and web server require + * @return This object contains the informaton the service manager and web server require * for correct management and display of the service. */ public abstract ServiceStatistics getStatistics(); Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/ServiceStatistics.java URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/ServiceStatistics.java?rev=1485814&r1=1485813&r2=1485814&view=diff ============================================================================== --- uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/ServiceStatistics.java (original) +++ uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/ServiceStatistics.java Thu May 23 18:36:22 2013 @@ -65,7 +65,7 @@ public class ServiceStatistics /** * Set the "health" of the service. This is called by each pinger for each service. - * @param alive Set to "true" if the service is healthy, "false" otherwise. + * @param healthy Set to "true" if the service is healthy, "false" otherwise. */ public void setHealthy(boolean healthy) {