NIFI-309 adding javadoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/72153c94 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/72153c94 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/72153c94 Branch: refs/heads/develop Commit: 72153c94532fc021fd973d3d8c31ed725beddd68 Parents: 90fd0ed Author: danbress <[email protected]> Authored: Sun Mar 8 12:03:27 2015 -0400 Committer: danbress <[email protected]> Committed: Fri Mar 20 09:49:29 2015 -0400 ---------------------------------------------------------------------- .../nifi/annotation/documentation/ReadsAttribute.java | 9 +++++++++ .../nifi/annotation/documentation/ReadsAttributes.java | 4 ++++ .../nifi/annotation/documentation/WritesAttribute.java | 10 ++++++++++ .../nifi/annotation/documentation/WritesAttributes.java | 4 ++++ 4 files changed, 27 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/72153c94/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttribute.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttribute.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttribute.java index d644d94..546db2d 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttribute.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttribute.java @@ -36,6 +36,15 @@ import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface ReadsAttribute { + /** + * The FlowFile attribute that is being read + * @return + */ public String attribute(); + + /** + * The description of how the attribute is being used + * @return + */ public String description() default ""; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/72153c94/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttributes.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttributes.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttributes.java index 9edd06f..78ba4ec 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttributes.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/ReadsAttributes.java @@ -35,5 +35,9 @@ import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface ReadsAttributes { + /** + * A list of attributes that may be read + * @return + */ public ReadsAttribute[] value(); } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/72153c94/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttribute.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttribute.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttribute.java index 16ef56b..43f4947 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttribute.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttribute.java @@ -36,6 +36,16 @@ import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface WritesAttribute { + + /** + * The FlowFile attribute that is being created or updated + * @return + */ public String attribute(); + + /** + * A description of what is being written to the FlowFile attribute + * @return + */ public String description() default ""; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/72153c94/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttributes.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttributes.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttributes.java index d9d2380..140c85d 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttributes.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/WritesAttributes.java @@ -36,5 +36,9 @@ import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface WritesAttributes { + /** + * A list of FlowFile attributes that may be written or updated + * @return + */ public WritesAttribute[] value(); }
