docs(api): add and update utility class documentation#1681
docs(api): add and update utility class documentation#1681mzarglis wants to merge 2 commits intochsami:developmentfrom
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThis PR adds and updates comprehensive API documentation across the docs/api/ directory. Seventeen documentation files are created or expanded, including new pages for Mouse, NewMenuEntry, Rs2Antiban, Rs2DepositBox, Rs2Farming, Rs2Gembag, Rs2GrandExchange, Rs2RunePouch, Rs2Shop, and Rs2WorldPoint. Several existing documentation files are enhanced with full content replacing TODO placeholders. Deprecation notices are added to Rs2GameObject, Rs2GroundItem, and Rs2Npc, directing users to the Queryable API as a migration path. No changes to implementation code are made. Possibly related PRs
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/api/Rs2DepositBox.md`:
- Around line 10-24: Update the first overload's description for
bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint
initialPlayerLocation) to use the same terminology as the other overloads:
change "Banks items if the inventory is full" to "Banks items if the inventory
does not have enough empty slots" (or equivalent phrasing referencing
emptySlotCount), so all four method descriptions consistently state they bank
when the inventory lacks sufficient empty slots and then walk back to the
initial player location.
| ### `bankItemsAndWalkBackToOriginalPosition` | ||
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation)` | ||
| - **Description**: Banks items if the inventory is full and returns to the initial player location. | ||
|
|
||
| ### `bankItemsAndWalkBackToOriginalPosition` | ||
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation, int emptySlotCount)` | ||
| - **Description**: Banks items if your inventory does not have enough empty slots. Will walk back to the initial player location. | ||
|
|
||
| ### `bankItemsAndWalkBackToOriginalPosition` | ||
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation, int emptySlotCount, int distance)` | ||
| - **Description**: Banks items if the inventory does not have enough empty slots. Will walk back to the initial player location, allowing a specified distance deviation. | ||
|
|
||
| ### `bankItemsAndWalkBackToOriginalPosition` | ||
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, boolean exactItemNames, WorldPoint initialPlayerLocation, int emptySlotCount, int distance)` | ||
| - **Description**: Banks items at a deposit box if the inventory does not have enough empty slots. Will walk back to the initial player location. Supports exact or partial item name matching. |
There was a problem hiding this comment.
Inconsistent terminology across overloaded method descriptions.
The first overload (lines 11-12) describes the behavior as "Banks items if the inventory is full", while the remaining three overloads (lines 15-16, 19-20, 23-24) describe it as "if the inventory does not have enough empty slots". These should use consistent terminology - preferably "if the inventory does not have enough empty slots" since the method accepts an emptySlotCount parameter in the more specific overloads.
📝 Suggested consistency fix
### `bankItemsAndWalkBackToOriginalPosition`
- **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation)`
-- **Description**: Banks items if the inventory is full and returns to the initial player location.
+- **Description**: Banks items if the inventory does not have enough empty slots and returns to the initial player location.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation)` | |
| - **Description**: Banks items if the inventory is full and returns to the initial player location. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation, int emptySlotCount)` | |
| - **Description**: Banks items if your inventory does not have enough empty slots. Will walk back to the initial player location. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation, int emptySlotCount, int distance)` | |
| - **Description**: Banks items if the inventory does not have enough empty slots. Will walk back to the initial player location, allowing a specified distance deviation. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, boolean exactItemNames, WorldPoint initialPlayerLocation, int emptySlotCount, int distance)` | |
| - **Description**: Banks items at a deposit box if the inventory does not have enough empty slots. Will walk back to the initial player location. Supports exact or partial item name matching. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation)` | |
| - **Description**: Banks items if the inventory does not have enough empty slots and returns to the initial player location. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation, int emptySlotCount)` | |
| - **Description**: Banks items if your inventory does not have enough empty slots. Will walk back to the initial player location. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, WorldPoint initialPlayerLocation, int emptySlotCount, int distance)` | |
| - **Description**: Banks items if the inventory does not have enough empty slots. Will walk back to the initial player location, allowing a specified distance deviation. | |
| ### `bankItemsAndWalkBackToOriginalPosition` | |
| - **Signature**: `public static boolean bankItemsAndWalkBackToOriginalPosition(List<String> itemNames, boolean exactItemNames, WorldPoint initialPlayerLocation, int emptySlotCount, int distance)` | |
| - **Description**: Banks items at a deposit box if the inventory does not have enough empty slots. Will walk back to the initial player location. Supports exact or partial item name matching. |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 14-14: Multiple headings with the same content
(MD024, no-duplicate-heading)
[warning] 18-18: Multiple headings with the same content
(MD024, no-duplicate-heading)
[warning] 22-22: Multiple headings with the same content
(MD024, no-duplicate-heading)
🤖 Prompt for AI Agents
In `@docs/api/Rs2DepositBox.md` around lines 10 - 24, Update the first overload's
description for bankItemsAndWalkBackToOriginalPosition(List<String> itemNames,
WorldPoint initialPlayerLocation) to use the same terminology as the other
overloads: change "Banks items if the inventory is full" to "Banks items if the
inventory does not have enough empty slots" (or equivalent phrasing referencing
emptySlotCount), so all four method descriptions consistently state they bank
when the inventory lacks sufficient empty slots and then walk back to the
initial player location.
1 participant
Summary
Add new and update existing API documentation for Microbot utility classes.
Changes
New documentation (10 files)
Mouse.mdNewMenuEntry.mdRs2Antiban.mdRs2DepositBox.mdRs2Farming.mdRs2Gembag.mdRs2GrandExchange.mdRs2RunePouch.mdRs2Shop.mdRs2WorldPoint.mdUpdated documentation (10 files)
Rs2Cannon.mdRs2GameObject.mdRs2GroundItem.mdRs2Npc.mdRs2Pvp.mdRs2Settings.mdRs2Spells.mdRs2Tab.mdRs2Walker.mdRs2Widget.md