Repository: camel Updated Branches: refs/heads/master aecd383d7 -> 9e4ef7d36
Fixed few javadoc warnings Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9e4ef7d3 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9e4ef7d3 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9e4ef7d3 Branch: refs/heads/master Commit: 9e4ef7d3652b48632332a653db9db0cbc6a4dc29 Parents: aecd383 Author: aldettinger <aldettin...@gmail.com> Authored: Thu Nov 10 18:22:11 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Fri Nov 11 19:26:57 2016 +0100 ---------------------------------------------------------------------- .../src/main/java/org/apache/camel/Attachment.java | 2 +- .../java/org/apache/camel/FluentProducerTemplate.java | 13 ++++++------- .../org/apache/camel/builder/DataFormatClause.java | 6 +++--- .../camel/component/validator/ValidatorEndpoint.java | 2 +- .../validator/ValidatorResourceResolverFactory.java | 2 +- .../camel/component/xslt/XsltUriResolverFactory.java | 2 +- .../org/apache/camel/impl/DefaultExchangeHolder.java | 2 +- .../org/apache/camel/impl/DefaultShutdownStrategy.java | 4 ++-- .../camel/processor/validation/SchemaReader.java | 4 ++-- .../java/org/apache/camel/spi/EndpointCompleter.java | 2 +- 10 files changed, 19 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/Attachment.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/Attachment.java b/camel-core/src/main/java/org/apache/camel/Attachment.java index 6cdc0e4..c2f6391 100644 --- a/camel-core/src/main/java/org/apache/camel/Attachment.java +++ b/camel-core/src/main/java/org/apache/camel/Attachment.java @@ -45,7 +45,7 @@ public interface Attachment { * Get all the headers for this header name. Returns null if no headers for * this header name are available. * - * @param headerName he name of this header + * @param name The name of this header * @return a list of all header values */ List<String> getHeaderAsList(String name); http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/FluentProducerTemplate.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/FluentProducerTemplate.java b/camel-core/src/main/java/org/apache/camel/FluentProducerTemplate.java index d4f5ead..688ce19 100644 --- a/camel-core/src/main/java/org/apache/camel/FluentProducerTemplate.java +++ b/camel-core/src/main/java/org/apache/camel/FluentProducerTemplate.java @@ -184,7 +184,7 @@ public interface FluentProducerTemplate extends Service { * ) * .withBody("the body") * .to("direct:start") - * .request() + * .request()} * </pre> * * Note that it is invoked only once. @@ -216,17 +216,16 @@ public interface FluentProducerTemplate extends Service { * FluentProducerTemplate.on(context) * .withProcessor( * exchange -> { - * exchange.getIn().setHeader("Key1", "Val1") - * exchange.getIn().setHeader("Key2", "Val2") - * exchange.getIn().setBody("the body") + * exchange.getIn().setHeader("Key1", "Val1"); + * exchange.getIn().setHeader("Key2", "Val2"); + * exchange.getIn().setBody("the body"); * } * ) * .to("direct:start") - * .request() + * .request()} * </pre> * - * @param processor - * @return + * @param processor */ FluentProducerTemplate withProcessor(Processor processor); http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java b/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java index 9d48884..cd89d05 100644 --- a/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java +++ b/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java @@ -351,7 +351,7 @@ public class DataFormatClause<T extends ProcessorDefinition<?>> { * into a MIME Multipart (with only one body part). * @param headersInline define the MIME Multipart headers as part of the message body * or as Camel headers - * @param includeHeadeers if headersInline is set to true all camel headers matching this + * @param includeHeaders if headersInline is set to true all camel headers matching this * regex are also stored as MIME headers on the Multipart * @param binaryContent have binary encoding for binary content (true) or use Base-64 * encoding for binary content (false) @@ -904,8 +904,8 @@ public class DataFormatClause<T extends ProcessorDefinition<?>> { /** * Uses the YAML data format * - * @param type the yaml type to use - * @param type the type for json snakeyaml type + * @param library the yaml type to use + * @param type the type for json snakeyaml type */ public T yaml(YAMLLibrary library, Class<?> type) { return dataFormat(new YAMLDataFormat(library, type)); http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java index 70dada6..d9b1db0 100644 --- a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java @@ -232,7 +232,7 @@ public class ValidatorEndpoint extends DefaultEndpoint { } /** For creating a resource resolver which depends on the endpoint resource URI. - * Must not be used in combination with method {@link #setResourceResolver(LSResourceResolver). + * Must not be used in combination with method {@link #setResourceResolver(LSResourceResolver)}. * If not set then {@link DefaultValidatorResourceResolverFactory} is used */ public void setResourceResolverFactory(ValidatorResourceResolverFactory resourceResolverFactory) { http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorResourceResolverFactory.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorResourceResolverFactory.java b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorResourceResolverFactory.java index 8004e72..d052b0e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorResourceResolverFactory.java +++ b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorResourceResolverFactory.java @@ -28,7 +28,7 @@ import org.apache.camel.CamelContext; * * <pre> * {@code <camel:recipientList>} - * {@code <camel:simple>}validator:${header.XSD_FILE}?resourceResolverFactory=#resourceResolverFactory{@code</camel:simple>} + * {@code <camel:simple>validator:${header.XSD_FILE}?resourceResolverFactory=#resourceResolverFactory</camel:simple>} * {@code </camel:recipientList>} * </pre> * http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/component/xslt/XsltUriResolverFactory.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltUriResolverFactory.java b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltUriResolverFactory.java index f9209a3..999dc7d 100644 --- a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltUriResolverFactory.java +++ b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltUriResolverFactory.java @@ -28,7 +28,7 @@ import org.apache.camel.CamelContext; * * <pre> * {@code <camel:recipientList>} - * {@code <camel:simple>}xslt:${header.XSLT_FILE}?uriResolverFactory=#uriResolverFactory{@code</camel:simple>} + * {@code <camel:simple>xslt:${header.XSLT_FILE}?uriResolverFactory=#uriResolverFactory</camel:simple>} * {@code </camel:recipientList>} * </pre> * http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/impl/DefaultExchangeHolder.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultExchangeHolder.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultExchangeHolder.java index cae7389..86a3673 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultExchangeHolder.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultExchangeHolder.java @@ -373,7 +373,7 @@ public class DefaultExchangeHolder implements Serializable { * We only want to store exchange property values of primitive and String related types, and * as well any caught exception that Camel routing engine has caught. * <p/> - * This default implementation will allow the same values as {@link #getValidHeaderValue(String, Object)} + * This default implementation will allow the same values as {@link #getValidHeaderValue(String, Object, boolean)} * and in addition any value of type {@link Throwable}. * * @param propertyName the property name http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/impl/DefaultShutdownStrategy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultShutdownStrategy.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultShutdownStrategy.java index 0a671d7..2cd2a46 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultShutdownStrategy.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultShutdownStrategy.java @@ -92,12 +92,12 @@ import org.slf4j.LoggerFactory; * You can customize this using the {@link #setShutdownRoutesInReverseOrder(boolean)} method. * <p/> * After route consumers have been shutdown, then any {@link ShutdownPrepared} services on the routes - * is being prepared for shutdown, by invoking {@link ShutdownPrepared#prepareShutdown(boolean)} which + * is being prepared for shutdown, by invoking {@link ShutdownPrepared#prepareShutdown(boolean,boolean)} which * <tt>force=false</tt>. * <p/> * Then if a timeout occurred and the strategy has been configured with shutdown-now on timeout, then * the strategy performs a more aggressive forced shutdown, by forcing all consumers to shutdown - * and then invokes {@link ShutdownPrepared#prepareShutdown(boolean)} with <tt>force=true</tt> + * and then invokes {@link ShutdownPrepared#prepareShutdown(boolean,boolean)} with <tt>force=true</tt> * on the services. This allows the services to know they should force shutdown now. * <p/> * When timeout occurred and a forced shutdown is happening, then there may be threads/tasks which are http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/processor/validation/SchemaReader.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/validation/SchemaReader.java b/camel-core/src/main/java/org/apache/camel/processor/validation/SchemaReader.java index d7230dd..68ea309 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/validation/SchemaReader.java +++ b/camel-core/src/main/java/org/apache/camel/processor/validation/SchemaReader.java @@ -41,8 +41,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Reads the schema used in the processor {@link ValidatingProcessor}. Contains - * the method {@link clearCachedSchema()} to force re-reading the schema. + * Reads the schema used in the processor {@link ValidatingProcessor}. + * A schema re-reading could be forced using {@link org.apache.camel.component.validator.ValidatorEndpoint#clearCachedSchema()}. */ public class SchemaReader { http://git-wip-us.apache.org/repos/asf/camel/blob/9e4ef7d3/camel-core/src/main/java/org/apache/camel/spi/EndpointCompleter.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/spi/EndpointCompleter.java b/camel-core/src/main/java/org/apache/camel/spi/EndpointCompleter.java index 3f634fe3..8fb5090 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/EndpointCompleter.java +++ b/camel-core/src/main/java/org/apache/camel/spi/EndpointCompleter.java @@ -33,7 +33,7 @@ public interface EndpointCompleter { * Given the configuration and completion text, return a list of possible completion values * for a command line, IDE or web based tool. * - * @returns the list of completion values if any (rather like bash completion, prefix values can be returned + * @return the list of completion values if any (rather like bash completion, prefix values can be returned * - such as just the directories in the current path rather than returning every possible file name on a disk). */ List<String> completeEndpointPath(ComponentConfiguration configuration, String completionText);
