Skip to content

Commit

Permalink
Updated some package-info javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
tastybento committed Nov 30, 2024
1 parent 55daa72 commit c8dc618
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 15 deletions.
20 changes: 14 additions & 6 deletions src/main/java/world/bentobox/bentobox/api/addons/package-info.java
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
/**
* This package covers all addon-specific API
* <p>
* The Addon class and the associated Pladdon are like Bukkit plugins
* but contain extra API specific for BentoBox games.
* </p>
* This package contains classes and interfaces related to BentoBox addons.
*
* Addons are modular extensions that enhance BentoBox functionality. Game-specific
* addons (e.g., BSkyBlock, AcidIsland) as well as generic addons (e.g., Challenges, Warps)
* are supported by this system. Developers can create custom addons to introduce
* new features or gamemodes.
*
* Since BentoBox was created, server tech has changed and code remapping is done and that
* is usually only applied when a Plugin is loaded, so developers should use Pladdons
* which are a wrapper for Addons in a Plugin.
*
* Key components:
* - AddonLoader: Manages the lifecycle of addons.
* - AddonConfig: Handles addon-specific configurations.
*
* @since 1.0
* @author tastybento
*
*/
package world.bentobox.bentobox.api.addons;
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
/**
* API for BentoBox commands
*/
/**
* This package contains classes and handlers for BentoBox commands.
*
* Commands allow players and administrators to interact with BentoBox, including
* managing islands, settings, and other in-game features. This package ensures
* smooth integration and execution of commands within the plugin.
* <p>
* The workhorse class is the abstract class CompositeCommand. It provides all the functionality for
* a command including automatic help, sub-commands, convenience methods, etc. See examples of how to use
Expand All @@ -13,6 +15,10 @@
* their own custom help if required, but most of the time it is not.
* </p>
* @author tastybento
*
*
* Key features:
* - Command registration and parsing.
* - Support for custom addon-specific commands.
* - Error handling and permission validation.
*/
package world.bentobox.bentobox.api.commands;
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/**
* Contains API related to configurations.
* Provides classes and interfaces for managing configuration settings within the BentoBox API.
* This package enables the definition, access, and manipulation of configuration options,
* facilitating the customization and extension of BentoBox's functionality.
*/
package world.bentobox.bentobox.api.configuration;
13 changes: 10 additions & 3 deletions src/main/java/world/bentobox/bentobox/api/events/package-info.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
/**
* API for all the events that BentoBox generates
*/
/**
* This package defines events used within the BentoBox framework.
*
* Events are triggered during key gameplay actions, such as island creation,
* deletion, or player interactions. Developers can use these events to customize
* behaviors or respond to actions in their addons.
*
* Key features:
* - Custom event classes (e.g., IslandCreateEvent, PlayerJoinEvent).
* - Integration with Bukkit's event system.
*
* @author tastybento
*
*/
Expand Down
10 changes: 10 additions & 0 deletions src/main/java/world/bentobox/bentobox/api/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/**
* This package provides the core API for interacting with the BentoBox framework.
*
* It enables developers to integrate their custom plugins or addons with BentoBox,
* offering simplified access to common functionalities like:
* - Island management (creation, deletion, permissions).
* - Player interactions within island-based games.
* - Events and hooks for extending core behavior.
*/
package world.bentobox.bentobox.api;
14 changes: 14 additions & 0 deletions src/main/java/world/bentobox/bentobox/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/**
* The core package for the BentoBox plugin.
*
* This package provides the foundational framework for island-based games like SkyBlock,
* AcidIsland, and others. It manages core plugin features such as the addon system,
* configuration, and APIs used by developers to create custom addons or extend
* the functionality of BentoBox.
*
* Key features:
* - A modular addon system to mix and match features and game modes.
* - Comprehensive APIs for island protection, GUIs, team management, and more.
* - Cross-compatibility with various game modes.
*/
package world.bentobox.bentobox;
8 changes: 7 additions & 1 deletion src/main/java/world/bentobox/bentobox/util/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@
* Look here before you write your own utility function. If it isn't here, but would be useful
* the submit a PR so others can avoid duplicating code!
* </p>
*
*
* This package provides utility classes and helpers for common tasks within BentoBox.
*
* These utilities simplify repetitive tasks like file handling, configuration management,
* and mathematical calculations. They are used throughout the framework and can be
* leveraged by addon developers.
*
* @author various
*
*/
Expand Down

0 comments on commit c8dc618

Please sign in to comment.