From 08de5c3355cb6382d31c866f34b596a8e9c6263b Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Thu, 6 Aug 2020 12:51:47 +0200 Subject: [PATCH] Fix javadoc checkstyle issue. Update generated READMEs --- applications/processor/filter-processor/README.adoc | 1 - applications/processor/image-recognition-processor/README.adoc | 2 +- applications/sink/wavefront-sink/README.adoc | 2 +- applications/source/http-source/README.adoc | 2 +- applications/source/twitter-search-source/README.adoc | 2 +- .../twitter/status/search/TwitterSearchSupplierProperties.java | 2 +- 6 files changed, 5 insertions(+), 6 deletions(-) diff --git a/applications/processor/filter-processor/README.adoc b/applications/processor/filter-processor/README.adoc index db61e062..a876d9c7 100644 --- a/applications/processor/filter-processor/README.adoc +++ b/applications/processor/filter-processor/README.adoc @@ -16,7 +16,6 @@ If the incoming type is `byte[]` and the content type is set to `text/plain` or == Options //tag::configuration-properties[] -$$filter.function.expression$$:: $$A SpEL expression to apply.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/image-recognition-processor/README.adoc b/applications/processor/image-recognition-processor/README.adoc index 5009f949..7fb79c0b 100644 --- a/applications/processor/image-recognition-processor/README.adoc +++ b/applications/processor/image-recognition-processor/README.adoc @@ -45,7 +45,7 @@ $$image.recognition.cache-model$$:: $$cache the pre-trained tensorflow model.$$ $$image.recognition.debug-output$$:: $$$$ *($$Boolean$$, default: `$$false$$`)* $$image.recognition.debug-output-path$$:: $$$$ *($$String$$, default: `$$image-recognition-result.png$$`)* $$image.recognition.model$$:: $$pre-trained tensorflow image recognition model. Note that the model must match the selected model type!$$ *($$String$$, default: `$$https://storage.googleapis.com/mobilenet_v2/checkpoints/mobilenet_v2_1.4_224.tgz#mobilenet_v2_1.4_224_frozen.pb$$`)* -$$image.recognition.model-type$$:: $$Supports three different pre-trained tensorflow image recognition models: Inception, MobileNetV1 and MobileNetV2 1. Inception graph uses "input" as input and "output" as output. 2. MobileNetV2 pre-trained models: https://github.com/tensorflow/models/tree/master/research/slim/nets/mobilenet#pretrained-models - normalized image size is always square (e.g. H=W) - graph uses "input" as input and "MobilenetV2/Predictions/Reshape_1" as output. 3. MobileNetV1 pre-trained models: https://github.com/tensorflow/models/blob/master/research/slim/nets/mobilenet_v1.md#pre-trained-models - graph uses "input" as input and "MobilenetV1/Predictions/Reshape_1" as output.$$ *($$ModelType$$, default: `$$$$`, possible values: `inception`,`mobilenetv1`,`mobilenetv2`)* +$$image.recognition.model-type$$:: $$Supports three different pre-trained tensorflow image recognition models: Inception, MobileNetV1 and MobileNetV2 1. Inception graph uses 'input' as input and 'output' as output. 2. MobileNetV2 pre-trained models: https://github.com/tensorflow/models/tree/master/research/slim/nets/mobilenet#pretrained-models - normalized image size is always square (e.g. H=W) - graph uses 'input' as input and 'MobilenetV2/Predictions/Reshape_1' as output. 3. MobileNetV1 pre-trained models: https://github.com/tensorflow/models/blob/master/research/slim/nets/mobilenet_v1.md#pre-trained-models - graph uses 'input' as input and 'MobilenetV1/Predictions/Reshape_1' as output.$$ *($$ModelType$$, default: `$$$$`, possible values: `inception`,`mobilenetv1`,`mobilenetv2`)* $$image.recognition.normalized-image-size$$:: $$Normalized image size.$$ *($$Integer$$, default: `$$224$$`)* $$image.recognition.response-size$$:: $$number of recognized images.$$ *($$Integer$$, default: `$$5$$`)* //end::configuration-properties[] diff --git a/applications/sink/wavefront-sink/README.adoc b/applications/sink/wavefront-sink/README.adoc index 3e3cf6c7..8e3fc91e 100644 --- a/applications/sink/wavefront-sink/README.adoc +++ b/applications/sink/wavefront-sink/README.adoc @@ -16,7 +16,7 @@ $$wavefront.metric-expression$$:: $$A SpEL expression that evaluates to a metric $$wavefront.metric-name$$:: $$The name of the metric.Defaults to the application name.$$ *($$String$$, default: `$$$$`)* $$wavefront.proxy-uri$$:: $$The URL of the Wavefront proxy.$$ *($$String$$, default: `$$$$`)* $$wavefront.source$$:: $$Unique application, host, container, or instance that emits metrics.$$ *($$String$$, default: `$$$$`)* -$$wavefront.tag-expression$$:: $$Collection of custom metadata associated with the metric.Point tags cannot be empty. Valid characters for keys: alphanumeric, hyphen ("-"), underscore ("_"), dot ("."). For values any character is allowed, including spaces. To include a double quote, escape it with a backslash, for example, \". A backslash cannot be the last character in the tag value. Maximum allowed length for a combination of a point tag key and value is 254 characters (255 including the "=" separating key and value). If the value is longer, the point is rejected and logged$$ *($$Map$$, default: `$$$$`)* +$$wavefront.tag-expression$$:: $$Collection of custom metadata associated with the metric.Point tags cannot be empty. Valid characters for keys: alphanumeric, hyphen ('-'), underscore ('_'), dot ('.'). For values any character is allowed, including spaces. To include a double quote, escape it with a backslash, A backslash cannot be the last character in the tag value. Maximum allowed length for a combination of a point tag key and value is 254 characters (255 including the '=' separating key and value). If the value is longer, the point is rejected and logged$$ *($$Map$$, default: `$$$$`)* $$wavefront.timestamp-expression$$:: $$A SpEL expression that evaluates to a timestamp of the metric (optional).$$ *($$Expression$$, default: `$$$$`)* $$wavefront.uri$$:: $$The URL of the Wavefront environment.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] diff --git a/applications/source/http-source/README.adoc b/applications/source/http-source/README.adoc index 38ddf66c..3c20747a 100644 --- a/applications/source/http-source/README.adoc +++ b/applications/source/http-source/README.adoc @@ -22,7 +22,7 @@ The **$$http$$** $$source$$ supports the following configuration properties: //tag::configuration-properties[] $$http.cors.allow-credentials$$:: $$Whether the browser should include any cookies associated with the domain of the request being annotated.$$ *($$Boolean$$, default: `$$$$`)* $$http.cors.allowed-headers$$:: $$List of request headers that can be used during the actual request.$$ *($$String[]$$, default: `$$$$`)* -$$http.cors.allowed-origins$$:: $$List of allowed origins, e.g. "https://domain1.com".$$ *($$String[]$$, default: `$$$$`)* +$$http.cors.allowed-origins$$:: $$List of allowed origins, e.g. https://domain1.com.$$ *($$String[]$$, default: `$$$$`)* $$http.mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$$$`)* $$http.path-pattern$$:: $$HTTP endpoint path mapping.$$ *($$String$$, default: `$$/$$`)* $$server.port$$:: $$Server HTTP port.$$ *($$Integer$$, default: `$$8080$$`)* diff --git a/applications/source/twitter-search-source/README.adoc b/applications/source/twitter-search-source/README.adoc index 3aebe37b..d9b459bc 100644 --- a/applications/source/twitter-search-source/README.adoc +++ b/applications/source/twitter-search-source/README.adoc @@ -30,7 +30,7 @@ $$twitter.search.count$$:: $$Number of tweets to return per page (e.g. per singl $$twitter.search.geocode.latitude$$:: $$User's latitude.$$ *($$Double$$, default: `$$-1$$`)* $$twitter.search.geocode.longitude$$:: $$User's longitude.$$ *($$Double$$, default: `$$-1$$`)* $$twitter.search.geocode.radius$$:: $$Radius (in kilometers) around the (latitude, longitude) point.$$ *($$Double$$, default: `$$-1$$`)* -$$twitter.search.lang$$:: $$Restricts searched tweets to the given language, given by an ISO 639-1 code.$$ *($$String$$, default: `$$$$`)* +$$twitter.search.lang$$:: $$Restricts searched tweets to the given language, given by an http://en.wikipedia.org/wiki/ISO_639-1 .$$ *($$String$$, default: `$$$$`)* $$twitter.search.page$$:: $$Number of pages (e.g. requests) to search backwards (from most recent to the oldest tweets) before start the search from the most recent tweets again. The total amount of tweets searched backwards is (page * count)$$ *($$Integer$$, default: `$$3$$`)* $$twitter.search.query$$:: $$Search tweets by search query string.$$ *($$String$$, default: `$$$$`)* $$twitter.search.restart-from-most-recent-on-empty-response$$:: $$Restart search from the most recent tweets on empty response. Applied only after the first restart (e.g. when since_id != UNBOUNDED)$$ *($$Boolean$$, default: `$$false$$`)* diff --git a/functions/supplier/twitter-supplier/src/main/java/org/springframework/cloud/fn/supplier/twitter/status/search/TwitterSearchSupplierProperties.java b/functions/supplier/twitter-supplier/src/main/java/org/springframework/cloud/fn/supplier/twitter/status/search/TwitterSearchSupplierProperties.java index 5013acf9..981c4fcf 100644 --- a/functions/supplier/twitter-supplier/src/main/java/org/springframework/cloud/fn/supplier/twitter/status/search/TwitterSearchSupplierProperties.java +++ b/functions/supplier/twitter-supplier/src/main/java/org/springframework/cloud/fn/supplier/twitter/status/search/TwitterSearchSupplierProperties.java @@ -57,7 +57,7 @@ public class TwitterSearchSupplierProperties { private int count = 100; /** - * Restricts searched tweets to the given language, given by an http://en.wikipedia.org/wiki/ISO_639-1 + * Restricts searched tweets to the given language, given by an http://en.wikipedia.org/wiki/ISO_639-1 . */ private String lang = null;