From 3d4a0cadc950d4440251efa11b55b0bfb0afdef7 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Thu, 6 Aug 2026 04:22:46 +0900 Subject: 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) --- crates/shirabe/src/config.rs | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'crates/shirabe/src/config.rs') diff --git a/crates/shirabe/src/config.rs b/crates/shirabe/src/config.rs index cb5b5ea9..f33aa24e 100644 --- a/crates/shirabe/src/config.rs +++ b/crates/shirabe/src/config.rs @@ -296,8 +296,6 @@ impl Config { } /// Merges new config values with the existing ones (overriding) - /// - /// @param array{config?: array, repositories?: array} $config pub fn merge(&mut self, config: &IndexMap, source: &str) { // override defaults with given config let config_section = config.get("config").cloned().unwrap_or(PhpMixed::Null); @@ -555,7 +553,6 @@ impl Config { } } - /// @return array pub fn get_repositories(&self) -> IndexMap { self.repositories.clone() } @@ -564,8 +561,6 @@ impl Config { /// /// @param int $flags Options (see class constants) /// @throws \RuntimeException - /// - /// @return mixed pub fn get(&self, key: &str) -> PhpMixed { self.get_with_flags(key, 0).unwrap_or(PhpMixed::Null) } @@ -949,7 +944,6 @@ impl Config { } } - /// @return array pub fn all(&mut self, flags: i64) -> anyhow::Result> { let mut all: IndexMap = IndexMap::new(); all.insert( @@ -976,7 +970,6 @@ impl Config { .unwrap_or_else(|| Self::SOURCE_UNKNOWN.to_string()) } - /// @param mixed $configValue fn set_source_of_config_value(&self, config_value: &PhpMixed, path: &str, source: &str) { self.source_of_config_value .borrow_mut() @@ -996,7 +989,6 @@ impl Config { } } - /// @return array pub fn raw(&self) -> IndexMap { let mut result: IndexMap = IndexMap::new(); result.insert( @@ -1016,8 +1008,6 @@ impl Config { /// /// @param string|mixed $value a config string that can contain {$refs-to-other-config} /// @param int $flags Options (see class constants) - /// - /// @return string|mixed fn process(&self, value: PhpMixed, flags: i64) -> anyhow::Result { if !is_string(&value) { return Ok(value); @@ -1063,10 +1053,6 @@ impl Config { /// /// This should be used to read COMPOSER_ environment variables /// that overload config values. - /// - /// @param non-empty-string $var - /// - /// @return string|false fn get_composer_env(&self, var: &str) -> PhpMixed { if self.use_environment { return match Platform::get_env(var) { -- cgit v1.3.1