This closes #3015: Cherry-pick #2987: javadoc improvements Revise javadoc for sdk, state, options, annotations, window, (and misc)
Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/aa8c9d10 Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/aa8c9d10 Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/aa8c9d10 Branch: refs/heads/release-2.0.0 Commit: aa8c9d10f27ecf974f797a2a940c1bb306d95e05 Parents: 46fa490 4950e32 Author: Kenneth Knowles <[email protected]> Authored: Tue May 9 19:42:40 2017 -0700 Committer: Kenneth Knowles <[email protected]> Committed: Tue May 9 19:42:40 2017 -0700 ---------------------------------------------------------------------- .../main/java/org/apache/beam/sdk/Pipeline.java | 57 +++++-------- .../org/apache/beam/sdk/PipelineResult.java | 11 ++- .../org/apache/beam/sdk/PipelineRunner.java | 10 +-- .../beam/sdk/annotations/Experimental.java | 25 +++--- .../apache/beam/sdk/annotations/Internal.java | 6 +- .../org/apache/beam/sdk/coders/AtomicCoder.java | 6 +- .../main/java/org/apache/beam/sdk/io/Read.java | 6 +- .../DefaultPipelineOptionsRegistrar.java | 3 +- .../beam/sdk/options/PipelineOptionSpec.java | 4 +- .../apache/beam/sdk/options/ValueProvider.java | 15 ++-- .../org/apache/beam/sdk/state/BagState.java | 6 +- .../apache/beam/sdk/state/CombiningState.java | 23 +++--- .../apache/beam/sdk/state/GroupingState.java | 17 ++-- .../org/apache/beam/sdk/state/MapState.java | 27 ++---- .../apache/beam/sdk/state/ReadableState.java | 16 ++-- .../org/apache/beam/sdk/state/SetState.java | 14 ++-- .../java/org/apache/beam/sdk/state/State.java | 6 +- .../org/apache/beam/sdk/state/StateBinder.java | 1 - .../org/apache/beam/sdk/state/StateContext.java | 1 - .../apache/beam/sdk/state/StateContexts.java | 5 +- .../org/apache/beam/sdk/state/StateSpecs.java | 86 ++++++++++++++------ .../org/apache/beam/sdk/state/TimeDomain.java | 8 +- .../java/org/apache/beam/sdk/state/Timer.java | 12 ++- .../org/apache/beam/sdk/state/TimerSpecs.java | 4 +- .../org/apache/beam/sdk/state/ValueState.java | 8 +- .../beam/sdk/state/WatermarkHoldState.java | 4 +- .../beam/sdk/transforms/windowing/AfterAll.java | 4 +- .../sdk/transforms/windowing/AfterFirst.java | 3 +- .../sdk/transforms/windowing/AfterPane.java | 3 +- .../windowing/AfterProcessingTime.java | 4 +- .../transforms/windowing/DefaultTrigger.java | 8 +- .../sdk/transforms/windowing/GlobalWindows.java | 5 +- .../transforms/windowing/InvalidWindows.java | 2 +- .../MergeOverlappingIntervalWindows.java | 6 +- .../beam/sdk/transforms/windowing/Never.java | 2 +- .../windowing/NonMergingWindowFn.java | 2 +- .../transforms/windowing/OrFinallyTrigger.java | 5 +- .../sdk/transforms/windowing/Repeatedly.java | 4 +- .../beam/sdk/transforms/windowing/Sessions.java | 13 +-- .../transforms/windowing/TimestampCombiner.java | 5 ++ .../beam/sdk/transforms/windowing/Window.java | 12 +-- .../beam/sdk/transforms/windowing/WindowFn.java | 10 +-- .../transforms/windowing/WindowMappingFn.java | 12 ++- .../java/org/apache/beam/sdk/values/PBegin.java | 26 +++--- 44 files changed, 271 insertions(+), 236 deletions(-) ----------------------------------------------------------------------
