[
https://issues.apache.org/jira/browse/FLUME-1021?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13225155#comment-13225155
]
[email protected] commented on FLUME-1021:
------------------------------------------------------
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/4240/
-----------------------------------------------------------
Review request for Flume.
Summary
-------
Adding additional javadoc documentation for interfaces.
The hope is to clarify various API contracts as well as to lower the barrier to
entry to the system for new developers.
These are only Javadoc comments. No lines of executable code have been changed.
This addresses bug FLUME-1021.
https://issues.apache.org/jira/browse/FLUME-1021
Diffs
-----
flume-ng-core/src/main/java/org/apache/flume/Channel.java b719220
flume-ng-core/src/main/java/org/apache/flume/Context.java a6341a5
flume-ng-core/src/main/java/org/apache/flume/CounterGroup.java 258805c
flume-ng-core/src/main/java/org/apache/flume/Event.java a017705
flume-ng-core/src/main/java/org/apache/flume/EventDeliveryException.java
d3dbb79
flume-ng-core/src/main/java/org/apache/flume/EventDrivenSource.java 6ceaf69
flume-ng-core/src/main/java/org/apache/flume/NamedComponent.java 1a65fe7
flume-ng-core/src/main/java/org/apache/flume/PollableSource.java 663315a
flume-ng-core/src/main/java/org/apache/flume/SinkRunner.java 9e46d87
flume-ng-core/src/main/java/org/apache/flume/Source.java ce2bbba
flume-ng-core/src/main/java/org/apache/flume/SourceRunner.java ef65650
flume-ng-core/src/main/java/org/apache/flume/channel/ChannelProcessor.java
104313b
flume-ng-core/src/main/java/org/apache/flume/source/EventDrivenSourceRunner.java
3baa6b3
Diff: https://reviews.apache.org/r/4240/diff
Testing
-------
Thanks,
Mike
> Document API contracts and expected behavior in additional interfaces,
> including Source
> ---------------------------------------------------------------------------------------
>
> Key: FLUME-1021
> URL: https://issues.apache.org/jira/browse/FLUME-1021
> Project: Flume
> Issue Type: Improvement
> Components: Docs
> Affects Versions: v1.0.0
> Reporter: Mike Percy
> Assignee: Mike Percy
> Fix For: v1.1.0
>
>
> We are lacking API documentation of several important interface contracts.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
