8000 Adds Doxygen \cond guards to Java class declarations to avoid falling… · CommandAPI/CommandAPI@e6f7796 · GitHub
[go: up one dir, main page]
Skip to content

Commit e6f7796

Browse files
JorelAliJorelAli
committed
Adds Doxygen \cond guards to Java class declarations to avoid falling into the doxygen/doxygen#8495 trap
1 parent 0cc5756 commit e6f7796

21 files changed

+125
-25
lines changed

‎commandapi-core/src/main/java/dev/jorel/commandapi/AbstractArgumentTree.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@
1111
* @param <Impl>The class extending this class, used as the return type for chain calls
1212
* @param <CommandSender> The CommandSender class used by the class extending this class
1313
*/
14-
public abstract class AbstractArgumentTree<Impl extends AbstractArgumentTree<Impl, Argument, CommandSender>,
15-
Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender> extends Executable<Impl, CommandSender> {
14+
public abstract class AbstractArgumentTree<Impl
15+
/// @cond DOX
16+
extends AbstractArgumentTree<Impl, Argument, CommandSender>
17+
/// @endcond
18+
, Argument
19+
/// @cond DOX
20+
extends AbstractArgument<?, ?, Argument, CommandSender>
21+
/// @endcond
22+
, CommandSender> extends Executable<Impl, CommandSender> {
1623

1724
final List<AbstractArgumentTree<?, Argument, CommandSender>> arguments = new ArrayList<>();
1825
final Argument argument;

‎commandapi-core/src/main/java/dev/jorel/commandapi/AbstractCommandAPICommand.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,15 @@
3939
* @param <Argument> The implementation of AbstractArgument used by the class extending this class
4040
* @param <CommandSender> The CommandSender class used by the class extending this class
4141
*/
42-
public abstract class AbstractCommandAPICommand<Impl extends AbstractCommandAPICommand<Impl, Argument, CommandSender>,
43-
Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender> extends ExecutableCommand<Impl, CommandSender> {
42+
public abstract class AbstractCommandAPICommand<Impl
43+
/// @cond DOX
44+
extends AbstractCommandAPICommand<Impl, Argument, CommandSender>
45+
/// @endcond
46+
, Argument
47+
/// @cond DOX
48+
extends AbstractArgument<?, ?, Argument, CommandSender>
49+
/// @endcond
50+
, CommandSender> extends ExecutableCommand<Impl, CommandSender> {
4451

4552
protected List<Argument> arguments = new ArrayList<>();
4653
protected List<Impl> subcommands = new ArrayList<>();

‎commandapi-core/src/main/java/dev/jorel/commandapi/AbstractCommandTree.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@
1111
* @param <Argument> The implementation of AbstractArgument being used by this class
1212
* @param <CommandSender> The CommandSender class used by the class extending this class
1313
*/
14-
public abstract class AbstractCommandTree<Impl extends AbstractCommandTree<Impl, Argument, CommandSender>,
15-
Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender> extends ExecutableCommand<Impl, CommandSender> {
14+
public abstract class AbstractCommandTree<Impl
15+
/// @cond DOX
16+
extends AbstractCommandTree<Impl, Argument, CommandSender>
17+
/// @endcond
18+
, Argument
19+
/// @cond DOX
20+
extends AbstractArgument<?, ?, Argument, CommandSender>
21+
/// @endcond
22+
, CommandSender> extends ExecutableCommand<Impl, CommandSender> {
1623

1724
private final List<AbstractArgumentTree<?, Argument, CommandSender>> arguments = new ArrayList<>();
1825

‎commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIConfig.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@
3030
* You shouldn't use this class directly. Instead, use an appropriate subclass that corresponds to
3131
* the platform you are developing for.
3232
*/
33-
public abstract class CommandAPIConfig<Impl extends CommandAPIConfig<Impl>> implements ChainableBuilder<Impl> {
33+
public abstract class CommandAPIConfig<Impl
34+
/// @cond DOX
35+
extends CommandAPIConfig<Impl>
36+
/// @endcond
37+
> implements ChainableBuilder<Impl> {
3438
// The default configuration. This should mirror the commandapi-plugin config.yml file.
3539
boolean verboseOutput = false;
3640
boolean silentLogs = false;

‎commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIExecutor.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@
5050
* @param <CommandSender> The CommandSender for this executor
5151
* @param <WrapperType> The AbstractCommandSender that wraps the CommandSender
5252
*/
53-
public class CommandAPIExecutor<CommandSender, WrapperType extends AbstractCommandSender<? extends CommandSender>> {
53+
public class CommandAPIExecutor<CommandSender, WrapperType
54+
/// @cond DOX
55+
extends AbstractCommandSender<? extends CommandSender>
56+
/// @endcond
57+
> {
5458

5559
private List<NormalExecutor<CommandSender, WrapperType>> normalExecutors;
5660
private List<ResultingExecutor<CommandSender, WrapperType>> resultingExecutors;

‎commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIHandler.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,11 @@
7474
* @param <Source> The class for running Brigadier commands
7575
*/
7676
@RequireField(in = CommandContext.class, name = "arguments", ofType = Map.class)
77-
public class CommandAPIHandler<Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender, Source> {
77+
public class CommandAPIHandler<Argument
78+
/// @cond DOX
79+
extends AbstractArgument<?, ?, Argument, CommandSender>
80+
/// @endcond
81+
, CommandSender, Source> {
7882
private static final SafeVarHandle<CommandContext<?>, Map<String, ParsedArgument<?, ?>>> commandContextArguments;
7983

8084
// Compute all var handles all in one go so we don't do this during main server

‎commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIPlatform.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
* @param <CommandSender> The class for running platforms commands
2020
* @param <Source> The class for running Brigadier commands
2121
*/
22-
public interface CommandAPIPlatform<Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender, Source> {
22+
public interface CommandAPIPlatform<Argument
23+
/// @cond DOX
24+
extends AbstractArgument<?, ?, Argument, CommandSender>
25+
/// @endcond
26+
, CommandSender, Source> {
2327
// Platform-specific loading, enabling, and disabling tasks
2428

2529
/**

‎commandapi-core/src/main/java/dev/jorel/commandapi/Executable.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@
1111
* @param <Impl> The class extending this class, used as the return type for chain calls
1212
* @param <CommandSender> The CommandSender class used by the class extending this class
1313
*/
14-
abstract class Executable<Impl extends Executable<Impl, CommandSender>, CommandSender> implements ChainableBuilder<Impl> {
14+
abstract class Executable<Impl
15+
/// @cond DOX
16+
extends Executable<Impl, CommandSender>
17+
/// @endcond
18+
, CommandSender> implements ChainableBuilder<Impl> {
1519

1620
/**
1721
* The CommandAPIExecutor for this executable implementation

‎commandapi-core/src/main/java/dev/jorel/commandapi/ExecutableCommand.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010
* @param <Impl> The class extending this class, used as the return type for chain calls
1111
* @param <CommandSender> The CommandSender class used by the class extending this class
1212
*/
13-
abstract class ExecutableCommand<Impl extends ExecutableCommand<Impl, CommandSender>, CommandSender> extends Executable<Impl, CommandSender> {
13+
abstract class ExecutableCommand<Impl
14+
/// @cond DOX
15+
extends ExecutableCommand<Impl, CommandSender>
16+
/// @endcond
17+
, CommandSender> extends Executable<Impl, CommandSender> {
1418

1519
/**
1620
* The Command's meta-data for this executable command

‎commandapi-core/src/main/java/dev/jorel/commandapi/Execution.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@
99
/**
1010
* A list of arguments which results in an execution. This is used for building branches in a {@link AbstractCommandTree}
1111
*/
12-
public class Execution<CommandSender, Argument extends AbstractArgument<?, ?, Argument, CommandSender>> {
12+
public class Execution<CommandSender, Argument
13+
/// @cond DOX
14+
extends AbstractArgument<?, ?, Argument, CommandSender>
15+
/// @endcond
16+
> {
1317

1418
private final List<Argument> arguments;
1519
private final CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>> executor;

0 commit comments

Comments
 (0)
0