From notifications-return-5926-archive-asf-public=cust-asf.ponee.io@ignite.apache.org  Sun Aug 11 05:54:59 2019
Return-Path: <notifications-return-5926-archive-asf-public=cust-asf.ponee.io@ignite.apache.org>
X-Original-To: archive-asf-public@cust-asf.ponee.io
Delivered-To: archive-asf-public@cust-asf.ponee.io
Received: from mail.apache.org (hermes.apache.org [207.244.88.153])
	by mx-eu-01.ponee.io (Postfix) with SMTP id 711201806C7
	for <archive-asf-public@cust-asf.ponee.io>; Sun, 11 Aug 2019 07:54:57 +0200 (CEST)
Received: (qmail 70871 invoked by uid 500); 11 Aug 2019 05:54:56 -0000
Mailing-List: contact notifications-help@ignite.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:notifications-help@ignite.apache.org>
List-Unsubscribe: <mailto:notifications-unsubscribe@ignite.apache.org>
List-Post: <mailto:notifications@ignite.apache.org>
List-Id: <notifications.ignite.apache.org>
Reply-To: dev@ignite.apache.org
Delivered-To: mailing list notifications@ignite.apache.org
Received: (qmail 70749 invoked by uid 99); 11 Aug 2019 05:54:56 -0000
Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 11 Aug 2019 05:54:56 +0000
From: GitBox <git@apache.org>
To: notifications@ignite.apache.org
Subject: [GitHub] [ignite] pavlukhin commented on a change in pull request #6760:
 IGNITE-12051: update javadoc for IgniteKernal class
Message-ID: <156550289629.10974.4782583023163456688.gitbox@gitbox.apache.org>
Date: Sun, 11 Aug 2019 05:54:56 -0000
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

pavlukhin commented on a change in pull request #6760: IGNITE-12051: update javadoc for IgniteKernal class
URL: https://github.com/apache/ignite/pull/6760#discussion_r312723044
 
 

 ##########
 File path: modules/core/src/main/java/org/apache/ignite/internal/IgniteKernal.java
 ##########
 @@ -293,52 +294,79 @@
 import static org.apache.ignite.lifecycle.LifecycleEventType.BEFORE_NODE_START;
 
 /**
- * Ignite kernal.
- * <p/>
- * See <a href="http://en.wikipedia.org/wiki/Kernal">http://en.wikipedia.org/wiki/Kernal</a> for information on the
- * misspelling.
+ * This class represents an implementation of the extended main Ignite API (called {@link IgniteEx}). It also controls
+ * the Ignite life cycle and allows listening for Ignite events.
+ * <p>
+ * Please, refer to the wiki <a href="http://en.wikipedia.org/wiki/Kernal">http://en.wikipedia.org/wiki/Kernal</a>
+ * for the information on the misspelling.
+ * <p>
+ * <h3>Start point</h3>
+ * The main entry point for all the Ignite instances creation is the <tt>org.apache.ignite.internal.IgniteKernal#start()</tt>
+ * method. It starts internal Ignites components (see {@link GridComponent}), for instance:
+ * <ul>
+ * <li>{@link GridManager} - a layer of indirection between kernal and SPI modules.</li>
+ * <li>{@link GridProcessor} - an objects responsible for particular internal process implementation.</li>
+ * <li>{@link IgnitePlugin} - an Ignite addition of user-provided functionality.</li>
+ * </ul>
+ * The <tt>start()</tt> method also perfoms additional validation of the provided {@link IgniteConfiguration} and
 
 Review comment:
   Why not `@link` or `@code`?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services