Repository: ignite Updated Branches: refs/heads/ignite-10639 fb4854200 -> e78b161a4
IGNITE-10639 Proof of concept for internal description for packages: Ignite internal Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/e78b161a Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/e78b161a Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/e78b161a Branch: refs/heads/ignite-10639 Commit: e78b161a4089b4c531c2197651a8185bb082309f Parents: fb48542 Author: Dmitriy Pavlov <[email protected]> Authored: Wed Dec 12 16:37:13 2018 +0300 Committer: Dmitriy Pavlov <[email protected]> Committed: Wed Dec 12 16:37:13 2018 +0300 ---------------------------------------------------------------------- .../src/main/java/org/apache/ignite/internal/README.md | 13 +++++++++++++ .../java/org/apache/ignite/internal/package-info.java | 2 +- .../ignite/internal/processors/package-info.java | 4 ++-- 3 files changed, 16 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/e78b161a/modules/core/src/main/java/org/apache/ignite/internal/README.md ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/internal/README.md b/modules/core/src/main/java/org/apache/ignite/internal/README.md new file mode 100644 index 0000000..57350f2 --- /dev/null +++ b/modules/core/src/main/java/org/apache/ignite/internal/README.md @@ -0,0 +1,13 @@ +Apache Ignite Internal Package. +------------------------------- + +Contains implementation classes for Apache Ignite. + +*Ignite Components* + + +All internal Ignite components implements [GridComponent.java](GridComponent.java) - interface for +- [processors](processors) and for +- [managers](managers) - has associated SPI. + +Service Provider Interface (SPI) abbreviation is here because Apache Ignite was designed as a pluggable product. But Ignite users usually do not define own implementations. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/e78b161a/modules/core/src/main/java/org/apache/ignite/internal/package-info.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/internal/package-info.java b/modules/core/src/main/java/org/apache/ignite/internal/package-info.java index 9d4c786..f897eea 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/package-info.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/package-info.java @@ -19,6 +19,6 @@ * <!-- Package description. --> * Contains main implementation. All classes and interfaces are not public API. * API Compatibility is not maintained. - * + * See also <a href='https://github.com/apache/ignite/tree/master/modules/core/src/main/java/org/apache/ignite/internal'>GitHub Readme</a> */ package org.apache.ignite.internal; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/e78b161a/modules/core/src/main/java/org/apache/ignite/internal/processors/package-info.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/internal/processors/package-info.java b/modules/core/src/main/java/org/apache/ignite/internal/processors/package-info.java index 5fc4796..16c8cdd 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/processors/package-info.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/processors/package-info.java @@ -16,8 +16,8 @@ */ /** - * <!-- Package description. --> - * TODO. + * Package with Apache Ignite internal Processors. + * Processor is Ignite component with lifecycle associated with node lifecycle. * * See also * <a href='https://github.com/apache/ignite/tree/master/modules/core/src/main/java/org/apache/ignite/internal/processors/'>Package Readme</a>
