nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joseph Witt (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (NIFI-309) Support additional documentation annotations
Date Sat, 21 Mar 2015 14:54:39 GMT

    [ https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14372812#comment-14372812
] 

Joseph Witt commented on NIFI-309:
----------------------------------

No need.  I have your stuff merged on my local develop with my mods applied.  I was just looking
for a +1 on that.  Want to make sure folks are cool with me moving a few of your 'documentation'
annotations to 'behavior'.

> Support additional documentation annotations
> --------------------------------------------
>
>                 Key: NIFI-309
>                 URL: https://issues.apache.org/jira/browse/NIFI-309
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Documentation & Website
>    Affects Versions: 0.0.1
>            Reporter: Dan Bress
>            Assignee: Dan Bress
>            Priority: Trivial
>         Attachments: NIFI-309-Patch-After-PR40.patch
>
>
> Additional documentation only annotations should be added to better describe ConfigurableComponents.
 These annotations are:
> DynamicProperties - this would indicate whether a component supports dynamic properties
or not, and provides a description.  This could be used by the UI to determine whether or
not to allow dynamic properties.  It could also be reflected in the documentation.
> DynamicRelationships - this would indicate whether a component has dynamic relationships,
like RouteOnAttribute and DistributeLoad do.  This could be reflected in the documentation.
> ReadsAttribute - indicates what attributes a Processor reads certain FlowFile attributes
on incoming FlowFiles.  This would be reflected in the documentation.
> WritesAttribute - indicates what attributes a Processor creates on outgoing FlowFile
attributes.  This would be reflected in the documentation.
> SeeAlso - Provides a mechanism to link one configurable component to another.  E.g. PutFile
& GetFile.  This would be used in the documentation.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message