Skip to content

Commit

Permalink
Fix PHPDoc types for other enums
Browse files Browse the repository at this point in the history
  • Loading branch information
JulianVennen committed Sep 8, 2023
1 parent 3de0f96 commit ab0f23d
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 38 deletions.
10 changes: 5 additions & 5 deletions lib/Api/FilesApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -1352,7 +1352,7 @@ public function getModFileDownloadURLRequest($mod_id, $file_id, string $contentT
*
* @param int $mod_id The mod id the files belong to (required)
* @param string $game_version Filter by game version string (optional)
* @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional)
* @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional)
* @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional)
Expand All @@ -1375,7 +1375,7 @@ public function getModFiles($mod_id, $game_version = null, $mod_loader_type = nu
*
* @param int $mod_id The mod id the files belong to (required)
* @param string $game_version Filter by game version string (optional)
* @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional)
* @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional)
* @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional)
Expand Down Expand Up @@ -1480,7 +1480,7 @@ public function getModFilesWithHttpInfo($mod_id, $game_version = null, $mod_load
*
* @param int $mod_id The mod id the files belong to (required)
* @param string $game_version Filter by game version string (optional)
* @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional)
* @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional)
* @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional)
Expand All @@ -1506,7 +1506,7 @@ function ($response) {
*
* @param int $mod_id The mod id the files belong to (required)
* @param string $game_version Filter by game version string (optional)
* @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional)
* @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional)
* @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional)
Expand Down Expand Up @@ -1561,7 +1561,7 @@ function ($exception) {
*
* @param int $mod_id The mod id the files belong to (required)
* @param string $game_version Filter by game version string (optional)
* @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional)
* @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional)
* @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional)
* @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional)
Expand Down
30 changes: 15 additions & 15 deletions lib/Api/ModsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -1294,9 +1294,9 @@ public function getModsRequest($get_mods_by_ids_list_request_body, string $conte
* @param int $category_id Filter by category id (optional)
* @param string $game_version Filter by game version string (optional)
* @param string $search_filter Filter by free text search in the mod name and author (optional)
* @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
* @param int $author_id Filter only mods that the given authorId is a member of. (optional)
* @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional)
Expand Down Expand Up @@ -1324,9 +1324,9 @@ public function searchMods($game_id, $class_id = null, $category_id = null, $gam
* @param int $category_id Filter by category id (optional)
* @param string $game_version Filter by game version string (optional)
* @param string $search_filter Filter by free text search in the mod name and author (optional)
* @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
* @param int $author_id Filter only mods that the given authorId is a member of. (optional)
* @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional)
Expand Down Expand Up @@ -1436,9 +1436,9 @@ public function searchModsWithHttpInfo($game_id, $class_id = null, $category_id
* @param int $category_id Filter by category id (optional)
* @param string $game_version Filter by game version string (optional)
* @param string $search_filter Filter by free text search in the mod name and author (optional)
* @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
* @param int $author_id Filter only mods that the given authorId is a member of. (optional)
* @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional)
Expand Down Expand Up @@ -1469,9 +1469,9 @@ function ($response) {
* @param int $category_id Filter by category id (optional)
* @param string $game_version Filter by game version string (optional)
* @param string $search_filter Filter by free text search in the mod name and author (optional)
* @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
* @param int $author_id Filter only mods that the given authorId is a member of. (optional)
* @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional)
Expand Down Expand Up @@ -1531,9 +1531,9 @@ function ($exception) {
* @param int $category_id Filter by category id (optional)
* @param string $game_version Filter by game version string (optional)
* @param string $search_filter Filter by free text search in the mod name and author (optional)
* @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $sort_field Filter by ModsSearchSortField enumeration (optional)
* @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
* @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
* @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
* @param int $author_id Filter only mods that the given authorId is a member of. (optional)
* @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional)
Expand Down
2 changes: 2 additions & 0 deletions lib/Model/File.php
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,7 @@ public function setFileName($file_name)
/**
* Gets release_type
*
* @see FileReleaseType
* @return int|null
*/
public function getReleaseType()
Expand All @@ -632,6 +633,7 @@ public function getReleaseType()
/**
* Sets release_type
*
* @see FileReleaseType
* @param int|null $release_type release_type
*
* @return self
Expand Down
6 changes: 4 additions & 2 deletions lib/Model/FileHash.php
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,8 @@ public function setValue($value)
/**
* Gets algo
*
* @return \Aternos\CurseForgeApi\Model\HashAlgo|null
* @see HashAlgo
* @return int|null
*/
public function getAlgo()
{
Expand All @@ -336,7 +337,8 @@ public function getAlgo()
/**
* Sets algo
*
* @param \Aternos\CurseForgeApi\Model\HashAlgo|null $algo algo
* @see HashAlgo
* @param int|null $algo algo
*
* @return self
*/
Expand Down
8 changes: 6 additions & 2 deletions lib/Model/FileIndex.php
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,7 @@ public function setFilename($filename)
/**
* Gets release_type
*
* @see FileReleaseType
* @return int|null
*/
public function getReleaseType()
Expand All @@ -418,6 +419,7 @@ public function getReleaseType()
/**
* Sets release_type
*
* @see FileReleaseType
* @param int|null $release_type release_type
*
* @return self
Expand Down Expand Up @@ -469,7 +471,8 @@ public function setGameVersionTypeId($game_version_type_id)
/**
* Gets mod_loader
*
* @return \Aternos\CurseForgeApi\Model\ModLoaderType|null
* @see ModLoaderType
* @return int|null
*/
public function getModLoader()
{
Expand All @@ -479,7 +482,8 @@ public function getModLoader()
/**
* Sets mod_loader
*
* @param \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader mod_loader
* @see ModLoaderType
* @param int|null $mod_loader mod_loader
*
* @return self
*/
Expand Down
6 changes: 4 additions & 2 deletions lib/Model/MinecraftGameVersion.php
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,8 @@ public function setGameVersionStatus($game_version_status)
/**
* Gets game_version_type_status
*
* @return \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null
* @see GameVersionTypeStatus
* @return int|null
*/
public function getGameVersionTypeStatus()
{
Expand All @@ -608,7 +609,8 @@ public function getGameVersionTypeStatus()
/**
* Sets game_version_type_status
*
* @param \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null $game_version_type_status game_version_type_status
* @see GameVersionTypeStatus
* @param int|null $game_version_type_status game_version_type_status
*
* @return self
*/
Expand Down
6 changes: 4 additions & 2 deletions lib/Model/MinecraftModLoaderIndex.php
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,8 @@ public function setDateModified($date_modified)
/**
* Gets type
*
* @return \Aternos\CurseForgeApi\Model\ModLoaderType|null
* @see ModLoaderType
* @return int|null
*/
public function getType()
{
Expand All @@ -472,7 +473,8 @@ public function getType()
/**
* Sets type
*
* @param \Aternos\CurseForgeApi\Model\ModLoaderType|null $type type
* @see ModLoaderType
* @param int|null $type type
*
* @return self
*/
Expand Down
24 changes: 16 additions & 8 deletions lib/Model/MinecraftModLoaderVersion.php
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,8 @@ public function setName($name)
/**
* Gets type
*
* @return \Aternos\CurseForgeApi\Model\ModLoaderType|null
* @see ModLoaderType
* @return int|null
*/
public function getType()
{
Expand All @@ -619,7 +620,8 @@ public function getType()
/**
* Sets type
*
* @param \Aternos\CurseForgeApi\Model\ModLoaderType|null $type type
* @see ModLoaderType
* @param int|null $type type
*
* @return self
*/
Expand Down Expand Up @@ -690,7 +692,8 @@ public function setFilename($filename)
/**
* Gets install_method
*
* @return \Aternos\CurseForgeApi\Model\ModLoaderInstallMethod|null
* @see ModLoaderInstallMethod
* @return int|null
*/
public function getInstallMethod()
{
Expand All @@ -700,7 +703,8 @@ public function getInstallMethod()
/**
* Sets install_method
*
* @param \Aternos\CurseForgeApi\Model\ModLoaderInstallMethod|null $install_method install_method
* @see ModLoaderInstallMethod
* @param int|null $install_method install_method
*
* @return self
*/
Expand Down Expand Up @@ -1041,7 +1045,8 @@ public function setModLoaderGameVersionStatus($mod_loader_game_version_status)
/**
* Gets mod_loader_game_version_type_status
*
* @return \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null
* @see GameVersionTypeStatus
* @return int|null
*/
public function getModLoaderGameVersionTypeStatus()
{
Expand All @@ -1051,7 +1056,8 @@ public function getModLoaderGameVersionTypeStatus()
/**
* Sets mod_loader_game_version_type_status
*
* @param \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null $mod_loader_game_version_type_status mod_loader_game_version_type_status
* @see GameVersionTypeStatus
* @param int|null $mod_loader_game_version_type_status mod_loader_game_version_type_status
*
* @return self
*/
Expand Down Expand Up @@ -1149,7 +1155,8 @@ public function setMcGameVersionStatus($mc_game_version_status)
/**
* Gets mc_game_version_type_status
*
* @return \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null
* @see GameVersionTypeStatus
* @return int|null
*/
public function getMcGameVersionTypeStatus()
{
Expand All @@ -1159,7 +1166,8 @@ public function getMcGameVersionTypeStatus()
/**
* Sets mc_game_version_type_status
*
* @param \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null $mc_game_version_type_status mc_game_version_type_status
* @see GameVersionTypeStatus
* @param int|null $mc_game_version_type_status mc_game_version_type_status
*
* @return self
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/Model/Mod.php
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ public function setSummary($summary)
/**
* Gets status
*
* @return \Aternos\CurseForgeApi\Model\ModStatus|null
* @return int|null
*/
public function getStatus()
{
Expand All @@ -632,7 +632,7 @@ public function getStatus()
/**
* Sets status
*
* @param \Aternos\CurseForgeApi\Model\ModStatus|null $status status
* @param int|null $status status
*
* @return self
*/
Expand Down

0 comments on commit ab0f23d

Please sign in to comment.