Add documentation for CommandAPI/CommandAPI#517

.gitignore

@@ -8,8 +8,9 @@ reference-code.iml
 reference-code/reference-code.iml
 reference-code/target
 reference-code/build
-reference-code/.kotlin
-reference-code/.gradle
+reference-code/**/build
+**/.kotlin
+**/.gradle
 
 package-lock.json
 .vscode

README.md

@@ -14,6 +14,12 @@ yarn install
 yarn docs:build
 ```
 
+### View website changes locally
+
+```bash
+yarn docs:dev
+```
+
 ### Verify reference code
 
 ```bash

docs/.vitepress/config.mts

@@ -114,7 +114,7 @@ const vitepressOptions: UserConfig = {
             }).then(_ => {
             })
         },
-        config: (md) => {
+        config: ( md) => {
             tabsPlugin(md);
             injectUpgradingPartsPlugin(md);
             mermaidSpaceConverter(md);

docs/.vitepress/theme/preference/PreferenceSwitch.vue

@@ -4,7 +4,12 @@
 import {VTIconChevronDown, VTSwitch} from '@vue/theme'
 import {useData, useRoute} from 'vitepress'
 import {onMounted, ref, Ref, watch} from 'vue'
-import {openPreference, openPreferenceKey, preferGroovyInGradle, preferGroovyInGradleKey, preferMaven, preferMavenKey, preferReobf, preferReobfKey,} from "./preference";
+import {
+    openPreference, openPreferenceKey, 
+    preferPaper, preferPaperKey,
+    preferGroovyInGradle, preferGroovyInGradleKey, 
+    preferMaven, preferMavenKey
+} from "./preference";
 
 const {frontmatter} = useData();
 let preferencesToDisplay: Ref<string[]> = ref();
@@ -36,6 +41,12 @@ const restoreOutline = (e: Event) => {
     (e.target as HTMLElement).classList.remove('no-outline');
 };
 
+const togglePaper = useToggleFn(
+    preferPaperKey,
+    preferPaper,
+    'prefer-paper'
+)
+
 const toggleMaven = useToggleFn(
     preferMavenKey,
     preferMaven,
@@ -48,12 +59,6 @@ const toggleGradleDsl = useToggleFn(
     'prefer-groovy'
 );
 
-const toggleMapping = useToggleFn(
-    preferReobfKey,
-    preferReobf,
-    'prefer-reobf'
-)
-
 function useToggleFn(
     storageKey: string,
     state: Ref<boolean>,
@@ -77,9 +82,9 @@ function useToggleFn(
 refresh()
 
 onMounted(() => {
+    togglePaper(preferPaper.value);
     toggleMaven(preferMaven.value);
     toggleGradleDsl(preferGroovyInGradle.value);
-    toggleMapping(preferReobf.value);
 });
 </script>
 
@@ -102,6 +107,16 @@ onMounted(() => {
              :aria-hidden="!openPreference"
         >
             <div class="mobile-wrapper switches">
+                <div v-if="preferencesToDisplay.includes('paper-spigot')" class="switch-container">
+                    <label class="paper-label prefer-label-left" @click="togglePaper(true)">Paper</label>
+                    <VTSwitch
+                        class="platform-switch"
+                        aria-label="prefer paper"
+                        :aria-checked="preferPaper"
+                        @click="togglePaper()"
+                    />
+                    <label class="spigot-label prefer-label-right" @click="togglePaper(false)">Spigot</label>
+                </div>
                 <div v-if="preferencesToDisplay.includes('build-system')" class="switch-container">
                     <label class="gradle-label prefer-label-left" @click="toggleMaven(false)">Gradle</label>
                     <VTSwitch
@@ -122,16 +137,6 @@ onMounted(() => {
                     />
                     <label class="groovy-label prefer-label-right" @click="toggleGradleDsl(true)">.gradle</label>
                 </div>
-                <div v-if="preferencesToDisplay.includes('mapping')" class="switch-container">
-                    <label class="mojmap-label prefer-label-left" @click="toggleMapping(false)">Mojmap</label>
-                    <VTSwitch
-                        class="mapping-switch"
-                        aria-label="prefer reobf"
-                        :aria-checked="preferReobf"
-                        @click="toggleMapping()"
-                    />
-                    <label class="reobf-label prefer-label-right" @click="toggleMapping(true)">Reobf</label>
-                </div>
             </div>
         </div>
         <br class="hide-on-mobile" :hidden="openPreference"/>
@@ -270,59 +275,63 @@ onMounted(() => {
 </style>
 
 <style>
+.paper,
 .maven,
-.groovy,
-.reobf {
+.groovy {
     display: none;
 }
 
+.prefer-paper .spigot,
 .prefer-maven .gradle,
-.prefer-groovy .kts,
-.prefer-reobf .mojmap {
+.prefer-groovy .kts {
     display: none;
 }
 
+.prefer-paper .paper,
 .prefer-maven .maven,
-.prefer-groovy .groovy,
-.prefer-reobf .reobf {
+.prefer-groovy .groovy {
     display: initial;
 }
 
+.paper-label,
 .maven-label,
 .groovy-label,
-.reobf-label,
+.prefer-paper .spigot-label,
 .prefer-maven .gradle-label,
-.prefer-groovy .kts-label,
-.prefer-reobf .mojmap-label {
+.prefer-groovy .kts-label {
     color: var(--vt-c-text-3);
 }
 
+.prefer-paper .paper-label,
 .prefer-maven .maven-label,
-.prefer-groovy .groovy-label,
-.prefer-reobf .reobf-label {
+.prefer-groovy .groovy-label {
     color: var(--vt-c-text-1);
 }
 
-.prefer-maven .api-switch .vt-switch-check {
+.platform-switch .vt-switch-check {
     transform: translateX(18px);
 }
 
-.prefer-groovy .dsl-switch .vt-switch-check {
+.prefer-paper .platform-switch .vt-switch-check {
+    transform: translateX(0px);
+}
+
+.prefer-maven .api-switch .vt-switch-check {
     transform: translateX(18px);
 }
 
-.prefer-reobf .mapping-switch .vt-switch-check {
+.prefer-groovy .dsl-switch .vt-switch-check {
     transform: translateX(18px);
 }
 
+.tip .paper,
+.tip .spigot,
 .tip .gradle,
 .tip .groovy,
 .tip .kts,
-.tip .maven,
-.tip .mojmap,
-.tip .reobf {
-    color: var(--vt-c-text-code);
+.tip .maven {
+    //color: var(--vt-c-text-code);
     /* transition: color 0.5s; */
-    font-weight: 600;
+    //font-weight: 600;
 }
 </style>

docs/.vitepress/theme/preference/preference.ts

@@ -12,11 +12,11 @@ function getBoolean(key: string, defaultValue: boolean) {
 export const openPreferenceKey = 'command-api-docs-prefer-open-preference'
 export const openPreference = ref(getBoolean(openPreferenceKey, true))
 
+export const preferPaperKey = 'command-api-docs-prefer-paper'
+export const preferPaper = ref(getBoolean(preferPaperKey, true))
+
 export const preferMavenKey = 'command-api-docs-prefer-maven'
 export const preferMaven = ref(getBoolean(preferMavenKey, false))
 
 export const preferGroovyInGradleKey = 'command-api-docs-prefer-groovy-dsl-in-gradle'
-export const preferGroovyInGradle = ref(getBoolean(preferGroovyInGradleKey, false))
-
-export const preferReobfKey = 'command-api-docs-prefer-mojmap'
-export const preferReobf = ref(getBoolean(preferReobfKey, false))
+export const preferGroovyInGradle = ref(getBoolean(preferGroovyInGradleKey, false))

docs/.vitepress/theme/upgrading/upgrading.ts

@@ -19,6 +19,7 @@ export const upgradingInfos: UpgradingInfo[] = [
     {from: '9.0.3', to: '9.1.0'},
     {from: '9.2.0', to: '9.3.0'},
     {from: '9.7.0', to: '10.0.0'},
+    {from: '10.1.2', to: '11.0.0'}
 ]
 
 export const keyVersions = Array.from(new Set(upgradingInfos.map(info => [info.from, info.to]).flat()));

docs/en/annotations/annotations.md

@@ -14,37 +14,37 @@ This page outlines in detail the list of all annotations that the CommandAPI's a
 
 The `@Command` annotation is used to declare a command. The parameter is the name of the command that will be registered.
 
-<<< @/../reference-code/src/main/java/annotations/WarpCommand.java#declareCommand
+<<< @/../reference-code/bukkit/src/main/java/annotations/WarpCommand.java#declareCommand
 
 ### `@Alias({...})`
 
 The `@Alias` annotation is used to declare a list of aliases for a command. The parameter is a list of aliases which can be used for the command.
 
-<<< @/../reference-code/src/main/java/annotations/aliasClassExample/TeleportCommand.java#aliasClassExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/aliasClassExample/TeleportCommand.java#aliasClassExample
 
 ### `@Permission("permissionNode")`
 
 The `@Permission` annotation is used to add a permission node to a command. Users that want to run this command must have this permission. The parameter is the permission node required to run the command.
 
-<<< @/../reference-code/src/main/java/annotations/permissionClassExample/TeleportCommand.java#permissionClassExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/permissionClassExample/TeleportCommand.java#permissionClassExample
 
 ### `@NeedsOp`
 
 The `@NeedsOp` annotation is used to indicate that a command needs to have operator privileges to run it. This annotation has no parameters.
 
-<<< @/../reference-code/src/main/java/annotations/needsOpClassExample/TeleportCommand.java#needsOpClassExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/needsOpClassExample/TeleportCommand.java#needsOpClassExample
 
 ### `@Help("Full description")`
 
 The `@Help` annotation is used to add a help topic to a command. This annotation can take two forms:
 
 A simple form which just uses a string which is used as the full description for a command:
 
-<<< @/../reference-code/src/main/java/annotations/helpClassExample/TeleportCommand.java#helpClassExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/helpClassExample/TeleportCommand.java#helpClassExample
 
 A form with two parameters `value` and `shortDescription`, to provide the full description (`value`) and short description (`shortDescription`) content for a command:
 
-<<< @/../reference-code/src/main/java/annotations/shortHelpClassExample/TeleportCommand.java#shortHelpClassExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/shortHelpClassExample/TeleportCommand.java#shortHelpClassExample
 
 ## Annotations that go on methods
 
@@ -54,27 +54,27 @@ To use annotations on methods, **methods must be static**.
 
 The `@Default` annotation indicates that the method is _not_ a subcommand. This acts in a similar way to regular Bukkit commands. Commands with the `@Default` annotation can be used to run the main code when the command named with the `@Command` annotation is stated, such as the following:
 
-<<< @/../reference-code/src/main/java/annotations/DefaultMethodExample.java#defaultMethodExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/DefaultMethodExample.java#defaultMethodExample
 
 The `@Default` annotation does not mean that the command can't have arguments! Arguments can still be used and declared as shown:
 
-<<< @/../reference-code/src/main/java/annotations/DefaultMethodExample.java#defaultWithArgsMethodExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/DefaultMethodExample.java#defaultWithArgsMethodExample
 
 ### `@Subcommand`
 
 The `@Subcommand` simply tells the CommandAPI that the declared method is a subcommand. This acts in a similar way to the regular CommandAPI's `.withSubcommand()` method. The subcommand annotation can take in a single string which is the name of the subcommand:
 
-<<< @/../reference-code/src/main/java/annotations/SubcommandMethodExample.java#subcommandMethodExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/SubcommandMethodExample.java#subcommandMethodExample
 
 Or, it can take in a list of strings which represent the _aliases_ that can also be used for the declared subcommand:
 
-<<< @/../reference-code/src/main/java/annotations/SubcommandMethodExample.java#subcommandAliasesMethodExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/SubcommandMethodExample.java#subcommandAliasesMethodExample
 
 ### `@Permission`
 
 The `@Permission` annotation can also be used on methods to indicate that a permission is required to execute a command.
 
-<<< @/../reference-code/src/main/java/annotations/PermissionMethodExample.java#permissionMethodExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/PermissionMethodExample.java#permissionMethodExample
 
 ### `@NeedsOp`
 
@@ -88,14 +88,14 @@ The annotations for arguments are really simple, there are just two things you n
 
 $$\begin{align}
 \texttt{StringArgument}&\xrightarrow{A}\texttt{@AStringArgument}\\\\
-\texttt{PlayerArgument}&\xrightarrow{A}\texttt{@APlayerArgument}\\\\
+\texttt{IntegerArgument}&\xrightarrow{A}\texttt{@AIntegerArgument}\\\\
 \texttt{AdvancementArgument}&\xrightarrow{A}\texttt{@AAdvancementArgument}\\\\
 &\hspace{0.75em}\vdots
 \end{align}$$
 
   For example, we use `@AStringArgument` to indicate that this command takes a `StringArgument` as its first parameter:
 
-<<< @/../reference-code/src/main/java/annotations/ParameterExample.java#simpleParameterExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/ParameterExample.java#simpleParameterExample
 
 - **The name of the argument (referred to as "nodeName" in the normal CommandAPI system) is the name of the variable assigned to the parameter.** In the above code, this means that the name of the argument is `warpName`.
 
@@ -107,18 +107,18 @@ Certain argument annotations have extra parameters that can be supplied to provi
 
 The following numerical arguments can take both a `min` and `max` value. Both of these are completely optional. This indicates the range of values (inclusive) that is valid for this argument. For example:
 
-<<< @/../reference-code/src/main/java/annotations/ParameterExample.java#numericalParameterExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/ParameterExample.java#numericalParameterExample
 
 #### Literal arguments
 
 Both the `LiteralArgument` and `MultiLiteralArgument` can be used. When these are used, the name of the variable assigned to the parameter is _ignored_ and not used as the argument's name.
 
 For the `@ALiteralArgument` annotation, the parameter is the literal to be used for the command. For the `@AMultiLiteralArgument`, the parameter can be an array of multiple literals to use:
 
-<<< @/../reference-code/src/main/java/annotations/ParameterExample.java#literalParameterExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/ParameterExample.java#literalParameterExample
 
 #### Other arguments
 
 The `LocationArgument`, `Location2DArgument`, `EntitySelectorArgument` and `ScoreHolderArgument` can all take an extra parameter in their constructors. As a result, the annotation-equivalent of these arguments also allow you to provide the parameter in the annotation:
 
-<<< @/../reference-code/src/main/java/annotations/ParameterExample.java#otherParameterExample
+<<< @/../reference-code/bukkit/src/main/java/annotations/ParameterExample.java#otherParameterExample