diff options
| author | nsfisis <nsfisis@gmail.com> | 2026-08-06 04:22:46 +0900 |
|---|---|---|
| committer | nsfisis <nsfisis@gmail.com> | 2026-08-06 04:23:22 +0900 |
| commit | 3d4a0cadc950d4440251efa11b55b0bfb0afdef7 (patch) | |
| tree | cf1cd680867b9aa633eafe6332b881711b738823 /crates/shirabe/src/command | |
| parent | ce6192f1cfaac63457b173f573ada661a4665bfb (diff) | |
| download | php-shirabe-3d4a0cadc950d4440251efa11b55b0bfb0afdef7.tar.gz php-shirabe-3d4a0cadc950d4440251efa11b55b0bfb0afdef7.tar.zst php-shirabe-3d4a0cadc950d4440251efa11b55b0bfb0afdef7.zip | |
chore: drop @param/@return tags that only restate Rust types
The ported docblocks copied @param and @return straight from the PHP
source. When such a tag carries nothing but a type and an argument name,
the Rust signature already states it, so the line is noise. Tags whose
text adds prose beyond the type are kept.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'crates/shirabe/src/command')
| -rw-r--r-- | crates/shirabe/src/command/base_command.rs | 9 | ||||
| -rw-r--r-- | crates/shirabe/src/command/create_project_command.rs | 4 | ||||
| -rw-r--r-- | crates/shirabe/src/command/init_command.rs | 4 | ||||
| -rw-r--r-- | crates/shirabe/src/command/package_discovery_trait.rs | 3 | ||||
| -rw-r--r-- | crates/shirabe/src/command/require_command.rs | 9 | ||||
| -rw-r--r-- | crates/shirabe/src/command/show_command.rs | 1 | ||||
| -rw-r--r-- | crates/shirabe/src/command/update_command.rs | 2 |
7 files changed, 0 insertions, 32 deletions
diff --git a/crates/shirabe/src/command/base_command.rs b/crates/shirabe/src/command/base_command.rs index f9682de9..41b8d0f8 100644 --- a/crates/shirabe/src/command/base_command.rs +++ b/crates/shirabe/src/command/base_command.rs @@ -211,23 +211,16 @@ pub trait BaseCommand: Command { input: std::rc::Rc<std::cell::RefCell<dyn InputInterface>>, ) -> anyhow::Result<std::rc::Rc<dyn PlatformRequirementFilterInterface>>; - /// @param array<string> $requirements - /// - /// @return array<string, string> fn format_requirements( &self, requirements: Vec<String>, ) -> anyhow::Result<IndexMap<String, String>>; - /// @param array<string> $requirements - /// - /// @return list<array{name: string, version?: string}> fn normalize_requirements( &self, requirements: Vec<String>, ) -> anyhow::Result<Vec<IndexMap<String, String>>>; - /// @param array<TableSeparator|mixed[]> $table fn render_table( &self, table: Vec<PhpMixed>, @@ -237,8 +230,6 @@ pub trait BaseCommand: Command { fn get_terminal_width(&self) -> i64; /// @internal - /// @param 'format'|'audit-format' $optName - /// @return Auditor::FORMAT_* fn get_audit_format( &self, input: std::rc::Rc<std::cell::RefCell<dyn InputInterface>>, diff --git a/crates/shirabe/src/command/create_project_command.rs b/crates/shirabe/src/command/create_project_command.rs index 756ebfac..260685c7 100644 --- a/crates/shirabe/src/command/create_project_command.rs +++ b/crates/shirabe/src/command/create_project_command.rs @@ -288,8 +288,6 @@ impl BaseCommand for CreateProjectCommand { } impl CreateProjectCommand { - /// @param string|array<string>|null $repositories - /// /// @throws \Exception #[allow(clippy::too_many_arguments)] pub fn install_project( @@ -632,8 +630,6 @@ impl CreateProjectCommand { Ok(0) } - /// @param array<string>|null $repositories - /// /// @throws \Exception #[allow(clippy::too_many_arguments)] fn install_root_package( diff --git a/crates/shirabe/src/command/init_command.rs b/crates/shirabe/src/command/init_command.rs index 6923f768..99a7de00 100644 --- a/crates/shirabe/src/command/init_command.rs +++ b/crates/shirabe/src/command/init_command.rs @@ -923,7 +923,6 @@ impl BaseCommand for InitCommand { } impl InitCommand { - /// @return array{name: string, email: string|null} fn parse_author_string( &self, author: &str, @@ -968,7 +967,6 @@ impl InitCommand { .into()) } - /// @return array<int, array{name: string, email?: string}> pub(crate) fn format_authors( &self, author: &str, @@ -1007,7 +1005,6 @@ impl InitCommand { Some(implode("\\", &namespace)) } - /// @return array<string, string> pub(crate) fn get_git_config(&self) -> IndexMap<String, String> { if self.git_config.borrow().is_some() { return self.git_config.borrow().clone().unwrap_or_default(); @@ -1161,7 +1158,6 @@ impl InitCommand { } } - /// @param array<string, string|array<string>> $options fn has_dependencies(&self, options: &IndexMap<String, PhpMixed>) -> bool { let requires = options.get("require").cloned().unwrap_or(PhpMixed::Null); let requires_arr_empty = match &requires { diff --git a/crates/shirabe/src/command/package_discovery_trait.rs b/crates/shirabe/src/command/package_discovery_trait.rs index cfd2d302..a1faff35 100644 --- a/crates/shirabe/src/command/package_discovery_trait.rs +++ b/crates/shirabe/src/command/package_discovery_trait.rs @@ -60,7 +60,6 @@ pub trait PackageDiscoveryTrait: BaseCommand { self.get_repos_mut().as_ref().unwrap().clone() } - /// @param key-of<BasePackage::STABILITIES>|null $minimumStability fn get_repository_set( &self, input: std::rc::Rc<std::cell::RefCell<dyn InputInterface>>, @@ -91,7 +90,6 @@ pub trait PackageDiscoveryTrait: BaseCommand { self.get_repository_sets_mut().get(&key).unwrap().clone() } - /// @return key-of<BasePackage::STABILITIES> fn get_minimum_stability( &self, input: std::rc::Rc<std::cell::RefCell<dyn InputInterface>>, @@ -750,7 +748,6 @@ pub trait PackageDiscoveryTrait: BaseCommand { )) } - /// @return array<string> fn find_similar(&self, package: &str) -> anyhow::Result<Vec<String>> { let results: Vec<SearchResult> = match (|| -> anyhow::Result<Vec<SearchResult>> { if self.get_repos_mut().is_none() { diff --git a/crates/shirabe/src/command/require_command.rs b/crates/shirabe/src/command/require_command.rs index 9d7d7553..d2b8360d 100644 --- a/crates/shirabe/src/command/require_command.rs +++ b/crates/shirabe/src/command/require_command.rs @@ -673,8 +673,6 @@ impl BaseCommand for RequireCommand { } impl RequireCommand { - /// @param array<string, string> $newRequirements - /// @return string[] fn get_inconsistent_require_keys( &self, new_requirements: &IndexMap<String, String>, @@ -694,7 +692,6 @@ impl RequireCommand { inconsistent_requirements } - /// @return array<string, string> fn get_packages_by_require_key(&self) -> IndexMap<String, String> { let json = self.json.borrow().as_ref().unwrap().clone(); let composer_definition = json.borrow_mut().read().unwrap_or_default(); @@ -748,9 +745,6 @@ impl RequireCommand { .unwrap_or_default() } - /// @param array<string, string> $requirements - /// @param 'require'|'require-dev' $requireKey - /// @param 'require'|'require-dev' $removeKey /// @throws \Exception fn do_update( &self, @@ -1053,7 +1047,6 @@ impl RequireCommand { Ok(status) } - /// @param list<string> $requirementsToUpdate fn update_requirements_after_resolution( &self, requirements_to_update: &[String], @@ -1192,7 +1185,6 @@ impl RequireCommand { Ok(0) } - /// @param array<string, string> $new fn update_file( &self, json: &std::rc::Rc<std::cell::RefCell<JsonFile>>, @@ -1235,7 +1227,6 @@ impl RequireCommand { let _ = json.borrow().write(PhpMixed::Array(composer_definition)); } - /// @param array<string, string> $new fn update_file_cleanly( &self, json: &std::rc::Rc<std::cell::RefCell<JsonFile>>, diff --git a/crates/shirabe/src/command/show_command.rs b/crates/shirabe/src/command/show_command.rs index a3bf7157..a6bb906d 100644 --- a/crates/shirabe/src/command/show_command.rs +++ b/crates/shirabe/src/command/show_command.rs @@ -1662,7 +1662,6 @@ impl ShowCommand { combined.keys().map(|k| strtolower(k)).collect() } - /// @return array|string|string[] pub(crate) fn get_version_style( &self, latest_package: PackageInterfaceHandle, diff --git a/crates/shirabe/src/command/update_command.rs b/crates/shirabe/src/command/update_command.rs index 8dcf7061..e5602763 100644 --- a/crates/shirabe/src/command/update_command.rs +++ b/crates/shirabe/src/command/update_command.rs @@ -602,8 +602,6 @@ impl BaseCommand for UpdateCommand { } impl UpdateCommand { - /// @param array<string> $packages - /// @return array<string> fn get_packages_interactively( &self, io: std::rc::Rc<std::cell::RefCell<dyn IOInterface>>, |
