Skip to content

Commit f714918

Browse files
committed
Added new package information and updated old ones
1 parent d6d2914 commit f714918

File tree

9 files changed

+159
-11
lines changed

9 files changed

+159
-11
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Command Framework - Annotation based command framework
3+
* Copyright (C) 2025 Berke Akçen
4+
*
5+
* This program is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* This program is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU General Public License
16+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
/**
20+
* Contains all annotations provided by the Command Framework.
21+
* <p>
22+
* These annotations are used to define and configure commands,
23+
* subcommands, and other framework-related behaviors.
24+
*/
25+
package me.despical.commandframework.annotations;
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* Command Framework - Annotation based command framework
3+
* Copyright (C) 2025 Berke Akçen
4+
*
5+
* This program is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* This program is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU General Public License
16+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
/**
20+
* Provides an internal class responsible for handling command and subcommand confirmations.
21+
* <p>
22+
* This class is intended for internal use only and should not be accessed
23+
* or instantiated outside the Command Framework.
24+
*
25+
* @see me.despical.commandframework.confirmations.ConfirmationManager
26+
* @see me.despical.commandframework.annotations.Confirmation
27+
* @see me.despical.commandframework.options.FrameworkOption#CONFIRMATIONS
28+
*/
29+
package me.despical.commandframework.confirmations;
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* Command Framework - Annotation based command framework
3+
* Copyright (C) 2025 Berke Akçen
4+
*
5+
* This program is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* This program is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU General Public License
16+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
/**
20+
* Provides an internal class responsible for handling command cooldowns.
21+
* <p>
22+
* This class is not intended to be instantiated or used directly
23+
* outside the Command Framework.
24+
*
25+
* @see me.despical.commandframework.cooldown.CooldownManager
26+
* @see me.despical.commandframework.annotations.Cooldown
27+
* @see me.despical.commandframework.options.FrameworkOption#CUSTOM_COOLDOWN_CHECKER
28+
*/
29+
package me.despical.commandframework.cooldown;
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Command Framework - Annotation based command framework
3+
* Copyright (C) 2025 Berke Akçen
4+
*
5+
* This program is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* This program is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU General Public License
16+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
/**
20+
* Contains the {@link me.despical.commandframework.debug.Debug} annotation and
21+
* {@link me.despical.commandframework.debug.DebugLogger}, used exclusively for
22+
* debugging purposes.
23+
*/
24+
package me.despical.commandframework.debug;

src/main/java/me/despical/commandframework/exceptions/package-info.java

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@
1717
*/
1818

1919
/**
20-
* @author Despical
21-
* <p>
22-
* Created at 20.09.2024
20+
* Provides custom exception classes used by the Command Framework.
2321
*/
24-
@ApiStatus.Internal
2522
package me.despical.commandframework.exceptions;
26-
27-
import org.jetbrains.annotations.ApiStatus;
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/*
2+
* Command Framework - Annotation based command framework
3+
* Copyright (C) 2025 Berke Akçen
4+
*
5+
* This program is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* This program is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU General Public License
16+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
/**
20+
* Contains classes that define and handle framework options.
21+
*/
22+
package me.despical.commandframework.options;

src/main/java/me/despical/commandframework/package-info.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,9 @@
1717
*/
1818

1919
/**
20-
* Main package of the Command Framework that contains all the
21-
* classes related to this framework.
20+
* The main package of the Command Framework containing all
21+
* core classes and components related to the framework.
2222
*
23-
* @author Despical
2423
* @since 1.0.0
2524
*/
2625
package me.despical.commandframework;
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
* Command Framework - Annotation based command framework
3+
* Copyright (C) 2025 Berke Akçen
4+
*
5+
* This program is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* This program is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU General Public License
16+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
/**
20+
* Internal package containing the option parser.
21+
* Not intended for external use.
22+
*/
23+
@ApiStatus.Internal
24+
package me.despical.commandframework.parser;
25+
26+
import org.jetbrains.annotations.ApiStatus;

src/main/java/me/despical/commandframework/utils/package-info.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
*/
1818

1919
/**
20-
* This package is an internal utility package for the framework.
20+
* Provides internal utility classes and helpers for the Command Framework.
2121
*
22-
* @author Despical
2322
* @since 1.2.7
2423
*/
2524
@ApiStatus.Internal

0 commit comments

Comments
 (0)