CAMEL-7999: Add description to @UriParam as well.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9482e566 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9482e566 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9482e566 Branch: refs/heads/master Commit: 9482e56602815b81f2fbca7e796c179462ba7014 Parents: 65f0806 Author: Claus Ibsen <[email protected]> Authored: Fri Nov 14 08:44:34 2014 +0100 Committer: Claus Ibsen <[email protected]> Committed: Fri Nov 14 08:44:34 2014 +0100 ---------------------------------------------------------------------- .../org/apache/camel/component/ResourceEndpoint.java | 13 ++++++++----- .../java/org/apache/camel/impl/DefaultEndpoint.java | 14 +++++--------- .../camel/tools/apt/EndpointAnnotationProcessor.java | 4 ++-- .../src/main/java/org/apache/camel/spi/UriParam.java | 7 +++++++ 4 files changed, 22 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/9482e566/camel-core/src/main/java/org/apache/camel/component/ResourceEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/ResourceEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/ResourceEndpoint.java index 43ec709..d5d181f 100644 --- a/camel-core/src/main/java/org/apache/camel/component/ResourceEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/ResourceEndpoint.java @@ -42,9 +42,9 @@ import org.slf4j.LoggerFactory; public abstract class ResourceEndpoint extends ProcessorEndpoint implements ManagedResourceEndpointMBean { protected final Logger log = LoggerFactory.getLogger(getClass()); private volatile byte[] buffer; - @UriPath(description = "path to the resource") + @UriPath(description = "Path to the resource") private String resourceUri; - @UriParam(defaultValue = "false") + @UriParam(defaultValue = "false", description = "Sets whether to use resource content cache or not") private boolean contentCache; public ResourceEndpoint() { @@ -129,9 +129,7 @@ public abstract class ResourceEndpoint extends ProcessorEndpoint implements Mana } /** - * Sets whether to use resource content cache or not - default is <tt>false</tt>. - * - * @see #getResourceAsInputStream() + * Sets whether to use resource content cache or not. */ public void setContentCache(boolean contentCache) { this.contentCache = contentCache; @@ -141,6 +139,11 @@ public abstract class ResourceEndpoint extends ProcessorEndpoint implements Mana return resourceUri; } + /** + * Path to the resource + * + * @param resourceUri the resource path + */ public void setResourceUri(String resourceUri) { this.resourceUri = resourceUri; } http://git-wip-us.apache.org/repos/asf/camel/blob/9482e566/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpoint.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpoint.java index b5dba17..f724e43 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpoint.java @@ -59,11 +59,12 @@ public abstract class DefaultEndpoint extends ServiceSupport implements Endpoint private EndpointConfiguration endpointConfiguration; private CamelContext camelContext; private Component component; - @UriParam(defaultValue = "InOnly") + @UriParam(defaultValue = "InOnly", description = "Sets the default exchange pattern when creating an exchange") private ExchangePattern exchangePattern = ExchangePattern.InOnly; // option to allow end user to dictate whether async processing should be // used or not (if possible) - @UriParam(defaultValue = "false") + @UriParam(defaultValue = "false", + description = "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).") private boolean synchronous; private final String id = EndpointHelper.createEndpointId(); private Map<String, Object> consumerProperties; @@ -240,17 +241,14 @@ public abstract class DefaultEndpoint extends ServiceSupport implements Endpoint } /** - * Returns the default exchange pattern to use for createExchange(). - * - * @see #setExchangePattern(ExchangePattern exchangePattern) + * Returns the default exchange pattern to use when creating an exchange. */ public ExchangePattern getExchangePattern() { return exchangePattern; } /** - * Sets the default exchange pattern to use for {@link #createExchange()}. - * The default value is {@link ExchangePattern#InOnly} + * Sets the default exchange pattern when creating an exchange. */ public void setExchangePattern(ExchangePattern exchangePattern) { this.exchangePattern = exchangePattern; @@ -258,8 +256,6 @@ public abstract class DefaultEndpoint extends ServiceSupport implements Endpoint /** * Returns whether synchronous processing should be strictly used. - * - * @see #setSynchronous(boolean synchronous) */ public boolean isSynchronous() { return synchronous; http://git-wip-us.apache.org/repos/asf/camel/blob/9482e566/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java index 3a41ebb..82b4313 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java @@ -411,8 +411,8 @@ public class EndpointAnnotationProcessor extends AbstractProcessor { } } } - if (docComment == null) { - docComment = ""; + if (isNullOrEmpty(docComment)) { + docComment = param.description(); } // gather enums http://git-wip-us.apache.org/repos/asf/camel/blob/9482e566/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriParam.java ---------------------------------------------------------------------- diff --git a/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriParam.java b/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriParam.java index 2724999..3e6b363 100644 --- a/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriParam.java +++ b/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriParam.java @@ -51,4 +51,11 @@ public @interface UriParam { */ String defaultValueNote() default ""; + /** + * Returns a description of this parameter. + * <p/> + * This is used for documentation and tooling only. + */ + String description() default ""; + } \ No newline at end of file
