From 77bc3bd3c2e02cd2f3b89e394551de800d66ce65 Mon Sep 17 00:00:00 2001 From: James Seibel Date: Thu, 29 Jun 2023 20:56:14 -0500 Subject: [PATCH] add package-info files for api and coreapi package documentation --- .../com/seibel/distanthorizons/api/package-info.java | 5 +++++ .../seibel/distanthorizons/coreapi/package-info.java | 11 +++++++++++ 2 files changed, 16 insertions(+) create mode 100644 api/src/main/java/com/seibel/distanthorizons/api/package-info.java create mode 100644 api/src/main/java/com/seibel/distanthorizons/coreapi/package-info.java diff --git a/api/src/main/java/com/seibel/distanthorizons/api/package-info.java b/api/src/main/java/com/seibel/distanthorizons/api/package-info.java new file mode 100644 index 000000000..58917cf56 --- /dev/null +++ b/api/src/main/java/com/seibel/distanthorizons/api/package-info.java @@ -0,0 +1,5 @@ +/** + * Start Here
+ * {@link com.seibel.distanthorizons.api.DhApi} has almost every method you would want. + */ +package com.seibel.distanthorizons.api; diff --git a/api/src/main/java/com/seibel/distanthorizons/coreapi/package-info.java b/api/src/main/java/com/seibel/distanthorizons/coreapi/package-info.java new file mode 100644 index 000000000..4f122f9b5 --- /dev/null +++ b/api/src/main/java/com/seibel/distanthorizons/coreapi/package-info.java @@ -0,0 +1,11 @@ +/** + * Only For Internal Use
+ * Everything in here for DH internally use.

+ * + * You can use objects and methods from here if you want, (I'm a javaDoc, not the cops) + * but using anything from this package is unsupported and may change at any time.

+ * + * When in doubt, if a method starts with "DhApi" it is safe to use, and we will + * do our best to avoid breaking changes. + */ +package com.seibel.distanthorizons.coreapi;