Javadoc fixes

This commit is contained in:
paulevsGitch 2021-08-10 11:46:30 +03:00
parent c48c06d2f8
commit 56592f3034
2 changed files with 40 additions and 40 deletions

View file

@ -32,8 +32,8 @@ abstract public class DataExchange {
/** /**
* A Unique ID for the referenced File. * A Unique ID for the referenced File.
* <p> * <p>
* Files with the same {@link #modID} need to have a unique IDs. Normally the filename from {@link #FileHash(String, File, byte[], int, int)} * Files with the same {@link #modID} need to have a unique IDs. Normally the filename from FileHash(String, File, byte[], int, int)
* is used to generated that ID, but you can directly specify one using {@link #FileHash(String, String, byte[], int, int)}. * is used to generated that ID, but you can directly specify one using FileHash(String, String, byte[], int, int).
*/ */
@NotNull @NotNull
public final String uniqueID; public final String uniqueID;
@ -156,7 +156,7 @@ abstract public class DataExchange {
* Automatically called before the player enters the world. * Automatically called before the player enters the world.
* <p> * <p>
* This is automatically called by BCLib. It will send all {@link DataHandler}-Objects that have {@link DataHandlerDescriptor#sendBeforeEnter} set to* * This is automatically called by BCLib. It will send all {@link DataHandler}-Objects that have {@link DataHandlerDescriptor#sendBeforeEnter} set to*
* {@Code true}, * {@code true},
*/ */
@Environment(EnvType.CLIENT) @Environment(EnvType.CLIENT)
public static void sendOnEnter(){ public static void sendOnEnter(){

View file

@ -16,43 +16,43 @@ import java.io.File;
/** /**
* This message is sent once a player enters the world. It initiates a sequence of Messages that will sync files between both * This message is sent once a player enters the world. It initiates a sequence of Messages that will sync files between both
* client and server. * client and server.
* <p> * <table>
* <tab<le> * <caption></caption>
* <tr> * <tr>
* <th>Server</th> * <th>Server</th>
* <th></th> * <th></th>
* <th>Client</th> * <th>Client</th>
* <th></th> * <th></th>
* </tr> * </tr>
* <tr> * <tr>
* <td colspan="4">Player enters World</td> * <td colspan="4">Player enters World</td>
* </tr> * </tr>
* <tr> * <tr>
* <td></td> * <td></td>
* <td>&lt;--</td> * <td>&lt;--</td>
* <td>{@link HelloServer}</td> * <td>{@link HelloServer}</td>
* <td>Sends the current BLib-Version installed on the Client</td> * <td>Sends the current BLib-Version installed on the Client</td>
* </tr> * </tr>
* <tr> * <tr>
* <td>{@link HelloClient}</td> * <td>{@link HelloClient}</td>
* <td>--&gt;</td> * <td>--&gt;</td>
* <td></td> * <td></td>
* <td>Sends the current BClIb-Version, the Version of all Plugins and data for all AutpoSync-Files * <td>Sends the current BClIb-Version, the Version of all Plugins and data for all AutpoSync-Files
* ({@link DataExchangeAPI#addAutoSyncFile(String, File)} on the Server</td> * ({@link DataExchangeAPI#addAutoSyncFile(String, File)} on the Server</td>
* </tr> * </tr>
* <tr> * <tr>
* <td></td> * <td></td>
* <td>&lt;--</td> * <td>&lt;--</td>
* <td>{@link RequestFiles}</td> * <td>{@link RequestFiles}</td>
* <td>Request missing or out of sync Files from the Server</td> * <td>Request missing or out of sync Files from the Server</td>
* </tr> * </tr>
* <tr> * <tr>
* <td>{@link SendFiles}</td> * <td>{@link SendFiles}</td>
* <td>--&gt;</td> * <td>--&gt;</td>
* <td></td> * <td></td>
* <td>Send Files from the Server to the Client</td> * <td>Send Files from the Server to the Client</td>
* </tr> * </tr>
* </table> * </table>
*/ */
public class HelloServer extends DataHandler { public class HelloServer extends DataHandler {
public static DataHandlerDescriptor DESCRIPTOR = new DataHandlerDescriptor(new ResourceLocation(BCLib.MOD_ID, "hello_server"), HelloServer::new, true, false); public static DataHandlerDescriptor DESCRIPTOR = new DataHandlerDescriptor(new ResourceLocation(BCLib.MOD_ID, "hello_server"), HelloServer::new, true, false);