Fix PHPDoc for PluginFileProblem and PluginProblem

aternosorg · Oct 18, 2024 · 2ea2b50 · 2ea2b50
1 parent c1edceb
commit 2ea2b50
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/src/Analysis/Problem/Bukkit/PluginFileProblem.php b/src/Analysis/Problem/Bukkit/PluginFileProblem.php
@@ -10,9 +10,9 @@
  * Class PluginFileProblem
  *
  * Represents a problem with a Bukkit plugin file and provides:
- *  - The file path
- *  - PluginInstallDifferentVersionSolution and PluginRemoveFileSolution
- * and extends the BukkitPluginProblem.
+ *  - The plugins' file path {@see PluginFileProblem::getPluginFilePath()}
+ *  - {@link PluginInstallDifferentVersionSolution} and {@link FileDeleteSolution}
+ *  - All features from {@link PluginProblem} (extends {@link PluginProblem})
  *
  * @package Aternos\Codex\Minecraft\Analysis\Problem\Bukkit
  */

diff --git a/src/Analysis/Problem/Bukkit/PluginProblem.php b/src/Analysis/Problem/Bukkit/PluginProblem.php
@@ -10,11 +10,11 @@
  * Class PluginProblem
  *
  * Represents a problem with a Bukkit plugin and provides:
- *  - The plugin name
- *  - PluginInstallDifferentVersionSolution and PluginRemoveSolution
- *  - Utility function to correct the plugin path
- *  - Utility function to extract the plugin name (without the file extension) from a plugin path
- *  - Utility function to extract the file name (with the file extension) from a plugin path
+ *  - The plugin name {@see PluginProblem::getPluginName()}
+ *  - {@link PluginInstallDifferentVersionSolution} and {@link PluginRemoveSolution}
+ *  - Utility function to correct the plugin path {@see PluginProblem::correctPluginPath()}
+ *  - Utility function to extract the plugin name (without the file extension) from a plugin path {@see PluginProblem::extractPluginName()}
+ *  - Utility function to extract the file name (with the file extension) from a plugin path {@see PluginProblem::extractPluginFileName()}
  *
  * @package Aternos\Codex\Minecraft\Analysis\Problem\Bukkit
  */