Skip to content

Commit e07d791

Browse files
committed
feat(bungee): add javadoc links
1 parent 0af56b3 commit e07d791

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

docs/minecraft/bungee.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<div class="grid cards" markdown>
88

99
- [:fontawesome-brands-github: Source Code](https://github.com/Incendo/cloud-minecraft/tree/master/cloud-bungee)
10+
- [:fontawesome-brands-java: JavaDoc](https://javadoc.io/doc/org.incendo/cloud-bungee)
1011
- [:fontawesome-brands-github: Example Plugin](https://github.com/Incendo/cloud-minecraft/tree/master/examples/example-bungee)
1112

1213
</div>
@@ -42,25 +43,27 @@ Cloud for BungeeCord is available through [Maven Central](https://central.sonaty
4243

4344
## Usage
4445

45-
`cloud-bungee` has a command manager implementation called `BungeeCommandManager` that can be created like:
46+
`cloud-bungee` has a command manager implementation called
47+
[`BungeeCommandManager`](https://javadoc.io/doc/org.incendo/cloud-bungee/latest/org/incendo/cloud/bungee/BungeeCommandManager.html)
48+
that can be created like:
4649

4750
```{ .java .annotate }
4851
BungeeCommandManager<YourSenderType> commandManager = new BungeeCommandManager<>(
4952
plugin,
50-
executionCoordinator, /* (1) */
51-
senderMapper /* (2) */
53+
executionCoordinator, /* (1)! */
54+
senderMapper /* (2)! */
5255
);
5356
```
5457

5558
1. Information about execution coordinators in general can be found
5659
[here](../core/index.md#execution-coordinators).
5760
2. The sender mapper is a two-way mapping between BungeeCord's
5861
[`CommandSender`](https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/net/md_5/bungee/api/CommandSender.html) and your custom sender type.
59-
You may use `SenderMapper.identity()` if using `CommandSender` as the sender type.
62+
You may use [`SenderMapper.identity()`](<https://javadoc.io/doc/org.incendo/cloud-core/latest/org/incendo/cloud/SenderMapper.html#identity()>) if using [`CommandSender`](https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/net/md_5/bungee/api/CommandSender.html) as the sender type.
6063

6164
## Parsers
6265

63-
| Parser | Type |
64-
| ------------ | --------------------------------------------------------------------------------------------------------------------------- |
65-
| PlayerParser | [ProxiedPlayer](https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/net/md_5/bungee/api/connection/ProxiedPlayer.html) |
66-
| ServerParser | [ServerInfo](https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/net/md_5/bungee/api/config/ServerInfo.html) |
66+
| Parser | Type |
67+
| ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
68+
| [PlayerParser](https://javadoc.io/doc/org.incendo/cloud-bungee/latest/org/incendo/cloud/bungee/parser/PlayerParser.html) | [ProxiedPlayer](https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/net/md_5/bungee/api/connection/ProxiedPlayer.html) |
69+
| [ServerParser](https://javadoc.io/doc/org.incendo/cloud-bungee/latest/org/incendo/cloud/bungee/parser/ServerParser.html) | [ServerInfo](https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/net/md_5/bungee/api/config/ServerInfo.html) |

0 commit comments

Comments
 (0)