From 99febc56df58e77b755b395662b99586845ecbd8 Mon Sep 17 00:00:00 2001
From: DmitriyMX <dimon550@gmail.com>
Date: Thu, 12 Jul 2018 12:10:33 +0300
Subject: [PATCH] Javadoc

---
 .../main/java/mc/core/network/CSPacket.java   |  3 ++
 .../main/java/mc/core/network/SCPacket.java   |  3 ++
 .../mc/core/network/proto_1_12_2/State.java   | 26 +++++++++++++++
 .../network/proto_1_12_2/package-info.java    | 32 +++++++++++++++++++
 .../proto_1_12_2/packets/BossBarPacket.java   |  8 +++++
 5 files changed, 72 insertions(+)
 create mode 100644 proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/package-info.java
 create mode 100644 proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/packets/BossBarPacket.java

diff --git a/core/src/main/java/mc/core/network/CSPacket.java b/core/src/main/java/mc/core/network/CSPacket.java
index 4dd785e..7ed00aa 100644
--- a/core/src/main/java/mc/core/network/CSPacket.java
+++ b/core/src/main/java/mc/core/network/CSPacket.java
@@ -4,6 +4,9 @@
  */
 package mc.core.network;
 
+/**
+ * Пакеты Client->Server
+ */
 public interface CSPacket {
     void readSelf(NetStream netStream);
 }
diff --git a/core/src/main/java/mc/core/network/SCPacket.java b/core/src/main/java/mc/core/network/SCPacket.java
index 92b68e9..9abba0e 100644
--- a/core/src/main/java/mc/core/network/SCPacket.java
+++ b/core/src/main/java/mc/core/network/SCPacket.java
@@ -4,6 +4,9 @@
  */
 package mc.core.network;
 
+/**
+ * Пакеты Server->Client
+ */
 public interface SCPacket {
     void writeSelf(NetStream netStream);
 }
diff --git a/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/State.java b/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/State.java
index 5d2144f..044d6d1 100644
--- a/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/State.java
+++ b/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/State.java
@@ -14,16 +14,33 @@ import mc.core.network.proto_1_12_2.packets.*;
 
 import java.util.Map;
 
+/**
+ * Для каждого состояния протокола имеется свой набор пакетов.
+ */
 @Slf4j
 @RequiredArgsConstructor
 public enum State {
+    /**
+     * Не известная стадия.
+     * Переход на этут стадию является следствием ошибки в работе протокола (умышленного или нет)
+     */
     UNKNOWN(-1, ImmutableMap.of(), ImmutableMap.of()),
+
+    /**
+     * Рукопожатие.
+     * С этого состояния начинается сюбое соединение с сервером.
+     */
     HANDSHAKE(0,
             ImmutableMap.<Integer, Class<? extends CSPacket>>builder()
                     .put(0x00, HandshakePacket.class)
                     .build(),
             null
     ),
+
+    /**
+     * Информация о сервере.
+     * Используется для получения Motd, кол-ва слотов и т.д.
+     */
     STATUS(1,
             ImmutableMap.<Integer, Class<? extends CSPacket>>builder()
                     .put(0x00, StatusRequestPacket.class)
@@ -34,6 +51,10 @@ public enum State {
                     .put(PingPacket.class, 0x01)
                     .build()
     ),
+
+    /**
+     * Стадия логина/авторизации.
+     */
     LOGIN(2,
             ImmutableMap.<Integer, Class<? extends CSPacket>>builder()
                     .put(0x00, LoginStartPacket.class)
@@ -43,6 +64,11 @@ public enum State {
                     .put(LoginSuccessPacket.class, 0x02)
                     .build()
     ),
+
+    /**
+     * Игровая стадия.
+     * Основная стадия протокола.
+     */
     PLAY(3,
             ImmutableMap.<Integer, Class<? extends CSPacket>>builder()
                     .put(0x00, TeleportConfirmPacket.class)
diff --git a/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/package-info.java b/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/package-info.java
new file mode 100644
index 0000000..d6207e6
--- /dev/null
+++ b/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/package-info.java
@@ -0,0 +1,32 @@
+/**
+ * Протокол Minecraft версии 1.12.2 (номер версии протокола - 340)
+ *
+ *
+ * Типы данных.
+ *
+ * (см. http://wiki.vg/Protocol#Data_types)
+ *
+ *
+ * Формат пакетов.
+ *
+ * Есть два варианта: без использования сжатия и с использованием.
+ * Регулируется это пакетом {@link mc.core.network.proto_1_12_2.packets.SetCompressionPacket}
+ *
+ * Формат без использования сжатия:
+ *
+ * +---------------+------------+--------------------+
+ * | Название      | Тип        | Комментарий        |
+ * +---------------+------------+--------------------+
+ * | Размер пакета | VarInt     | ID пакета + данные |
+ * +---------------+------------+--------------------+
+ * | ID пакета     | VarInt     |                    |
+ * +---------------+------------+--------------------+
+ * | Данные        | Byte Array |                    |
+ * +---------------+------------+--------------------+
+ *
+ * Формат с использованием сжатия:
+ *
+ * (см. http://wiki.vg/Protocol#With_compression)
+ */
+
+package mc.core.network.proto_1_12_2;
\ No newline at end of file
diff --git a/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/packets/BossBarPacket.java b/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/packets/BossBarPacket.java
new file mode 100644
index 0000000..abd56d9
--- /dev/null
+++ b/proto_1.12.2/src/main/java/mc/core/network/proto_1_12_2/packets/BossBarPacket.java
@@ -0,0 +1,8 @@
+/*
+ * DmitriyMX <dimon550@gmail.com>
+ * 2018-07-12
+ */
+package mc.core.network.proto_1_12_2.packets;
+
+public class BossBarPacket {
+}