aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/shirabe/src/dependency_resolver
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2026-08-06 04:22:46 +0900
committernsfisis <nsfisis@gmail.com>2026-08-06 04:23:22 +0900
commit3d4a0cadc950d4440251efa11b55b0bfb0afdef7 (patch)
treecf1cd680867b9aa633eafe6332b881711b738823 /crates/shirabe/src/dependency_resolver
parentce6192f1cfaac63457b173f573ada661a4665bfb (diff)
downloadphp-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/dependency_resolver')
-rw-r--r--crates/shirabe/src/dependency_resolver/pool.rs18
-rw-r--r--crates/shirabe/src/dependency_resolver/pool_optimizer.rs7
-rw-r--r--crates/shirabe/src/dependency_resolver/rule.rs5
-rw-r--r--crates/shirabe/src/dependency_resolver/transaction.rs9
4 files changed, 0 insertions, 39 deletions
diff --git a/crates/shirabe/src/dependency_resolver/pool.rs b/crates/shirabe/src/dependency_resolver/pool.rs
index a9dffe71..80534b0a 100644
--- a/crates/shirabe/src/dependency_resolver/pool.rs
+++ b/crates/shirabe/src/dependency_resolver/pool.rs
@@ -35,12 +35,6 @@ pub struct Pool {
}
impl Pool {
- /// @param BasePackage[] $packages
- /// @param BasePackage[] $unacceptableFixedOrLockedPackages
- /// @param array<string, array<string, string>> $removedVersions
- /// @param array<string, array<string, string>> $removedVersionsByPackage
- /// @param array<string, array<string, array<SecurityAdvisory|PartialSecurityAdvisory>>> $securityRemovedVersions
- /// @param array<string, array<string, string>> $abandonedRemovedVersions
pub fn new(
packages: Vec<BasePackageHandle>,
unacceptable_fixed_or_locked_packages: Vec<BasePackageHandle>,
@@ -67,7 +61,6 @@ impl Pool {
this
}
- /// @return array<string, string>
pub fn get_removed_versions(
&self,
name: &str,
@@ -89,12 +82,10 @@ impl Pool {
result
}
- /// @return array<string, array<string, string>>
pub fn get_all_removed_versions(&self) -> &IndexMap<String, IndexMap<String, String>> {
&self.removed_versions
}
- /// @return array<string, string>
pub fn get_removed_versions_by_package(&self, object_hash: &str) -> IndexMap<String, String> {
let Some(versions) = self.removed_versions_by_package.get(object_hash) else {
return IndexMap::new();
@@ -103,7 +94,6 @@ impl Pool {
versions.clone()
}
- /// @return array<string, array<string, string>>
pub fn get_all_removed_versions_by_package(
&self,
) -> &IndexMap<String, IndexMap<String, String>> {
@@ -133,7 +123,6 @@ impl Pool {
false
}
- /// @return string[]
pub fn get_security_advisory_identifiers_for_package_version(
&self,
package_name: &str,
@@ -183,21 +172,18 @@ impl Pool {
false
}
- /// @return array<string, array<string, array<SecurityAdvisory|PartialSecurityAdvisory>>>
pub fn get_all_security_removed_package_versions(
&self,
) -> &IndexMap<String, IndexMap<String, Vec<std::rc::Rc<AnySecurityAdvisory>>>> {
&self.security_removed_versions
}
- /// @return array<string, array<string, string>>
pub fn get_all_abandoned_removed_package_versions(
&self,
) -> &IndexMap<String, IndexMap<String, String>> {
&self.abandoned_removed_versions
}
- /// @param BasePackage[] $packages
fn set_packages(&mut self, packages: Vec<BasePackageHandle>) {
let mut id: i64 = 1;
@@ -216,7 +202,6 @@ impl Pool {
}
}
- /// @return BasePackage[]
pub fn get_packages(&self) -> &Vec<BasePackageHandle> {
&self.packages
}
@@ -259,7 +244,6 @@ impl Pool {
/// @param string $name The package name to be searched for
/// @param ?ConstraintInterface $constraint A constraint that all returned
/// packages must match or null to return all
- /// @return BasePackage[]
pub(crate) fn compute_what_provides(
&self,
name: &str,
@@ -286,7 +270,6 @@ impl Pool {
self.package_by_id(package_id)
}
- /// @param array<int, BasePackage> $installedMap
pub fn literal_to_pretty_string(
&self,
literal: i64,
@@ -376,7 +359,6 @@ impl Pool {
.any(|p| p.ptr_eq(&package))
}
- /// @return BasePackage[]
pub fn get_unacceptable_fixed_or_locked_packages(&self) -> &Vec<BasePackageHandle> {
&self.unacceptable_fixed_or_locked_packages
}
diff --git a/crates/shirabe/src/dependency_resolver/pool_optimizer.rs b/crates/shirabe/src/dependency_resolver/pool_optimizer.rs
index 16013e34..972d2f21 100644
--- a/crates/shirabe/src/dependency_resolver/pool_optimizer.rs
+++ b/crates/shirabe/src/dependency_resolver/pool_optimizer.rs
@@ -423,8 +423,6 @@ impl PoolOptimizer {
self.packages_to_remove.insert(id, true);
}
- /// @param array<string, array<string, array<string, list<BasePackage>>>> $identicalDefinitionsPerPackage
- /// @param array<int, array<string, array{groupHash: string, dependencyHash: string}>> $packageIdenticalDefinitionLookup
fn keep_package(
&mut self,
package: BasePackageHandle,
@@ -626,8 +624,6 @@ impl PoolOptimizer {
/// Disjunctive require constraints need to be considered in their own group. E.g. "^2.14 || ^3.3" needs to generate
/// two require constraint groups in order for us to keep the best matching package for "^2.14" AND "^3.3" as otherwise, we'd
/// only keep either one which can cause trouble (e.g. when using --prefer-lowest).
- ///
- /// @return void
fn extract_require_constraints_per_package(
&mut self,
package: &str,
@@ -644,8 +640,6 @@ impl PoolOptimizer {
/// Disjunctive conflict constraints need to be considered in their own group. E.g. "^2.14 || ^3.3" needs to generate
/// two conflict constraint groups in order for us to keep the best matching package for "^2.14" AND "^3.3" as otherwise, we'd
/// only keep either one which can cause trouble (e.g. when using --prefer-lowest).
- ///
- /// @return void
fn extract_conflict_constraints_per_package(
&mut self,
package: &str,
@@ -659,7 +653,6 @@ impl PoolOptimizer {
}
}
- /// @return ConstraintInterface[]
fn expand_disjunctive_multi_constraints(
&self,
constraint: AnyConstraint,
diff --git a/crates/shirabe/src/dependency_resolver/rule.rs b/crates/shirabe/src/dependency_resolver/rule.rs
index 4ed8619c..0ed442ce 100644
--- a/crates/shirabe/src/dependency_resolver/rule.rs
+++ b/crates/shirabe/src/dependency_resolver/rule.rs
@@ -129,12 +129,10 @@ impl Rule {
}
}
- /// @return self::RULE_*
pub fn get_reason(&self) -> i64 {
(self.bitfield() & (255 << BITFIELD_REASON)) >> BITFIELD_REASON
}
- /// @phpstan-return ReasonData
pub fn get_reason_data(&self) -> &ReasonData {
self.reason_data()
}
@@ -157,7 +155,6 @@ impl Rule {
}
}
- /// @param RuleSet::TYPE_* $type
pub fn set_type(&mut self, r#type: i64) {
*self.bitfield_mut() =
(self.bitfield() & !(255i64 << BITFIELD_TYPE)) | ((255 & r#type) << BITFIELD_TYPE);
@@ -302,8 +299,6 @@ impl Rule {
}
}
- /// @param BasePackage[] $installedMap
- /// @param array<Rule[]> $learnedPool
pub fn get_pretty_string(
&self,
repository_set: &RepositorySet,
diff --git a/crates/shirabe/src/dependency_resolver/transaction.rs b/crates/shirabe/src/dependency_resolver/transaction.rs
index 4abe85d4..78037338 100644
--- a/crates/shirabe/src/dependency_resolver/transaction.rs
+++ b/crates/shirabe/src/dependency_resolver/transaction.rs
@@ -47,8 +47,6 @@ impl Default for Transaction {
}
impl Transaction {
- /// @param PackageInterface[] $presentPackages
- /// @param PackageInterface[] $resultPackages
pub fn new(
present_packages: Vec<PackageInterfaceHandle>,
result_packages: Vec<PackageInterfaceHandle>,
@@ -68,7 +66,6 @@ impl Transaction {
&self.operations
}
- /// @param PackageInterface[] $resultPackages
fn set_result_package_maps(&mut self, result_packages: Vec<PackageInterfaceHandle>) {
let package_sort = |a: &PackageInterfaceHandle, b: &PackageInterfaceHandle| -> i64 {
// sort alias packages by the same name behind their non alias version
@@ -107,7 +104,6 @@ impl Transaction {
}
}
- /// @return OperationInterface[]
pub(crate) fn calculate_operations(&mut self) -> Vec<AnyOperation> {
let mut operations: Vec<AnyOperation> = vec![];
@@ -222,8 +218,6 @@ impl Transaction {
///
/// These serve as a starting point to enumerate packages in a topological order despite potential cycles.
/// If there are packages with a cycle on the top level the package with the lowest name gets picked
- ///
- /// @return array<string, PackageInterface>
pub(crate) fn get_root_packages(&self) -> IndexMap<String, PackageInterfaceHandle> {
let mut roots: IndexMap<String, PackageInterfaceHandle> = self
.result_package_map
@@ -251,7 +245,6 @@ impl Transaction {
roots
}
- /// @return PackageInterface[]
pub(crate) fn get_providers_in_result(&self, link: &Link) -> Vec<PackageInterfaceHandle> {
let Some(packages) = self.result_packages_by_name.get(link.get_target()) else {
return vec![];
@@ -269,7 +262,6 @@ impl Transaction {
/// it at least fixes the symptoms and makes usage of composer possible (again)
/// in such scenarios.
///
- /// @param OperationInterface[] $operations
/// @return OperationInterface[] reordered operation list
fn move_plugins_to_front(&self, mut operations: Vec<AnyOperation>) -> Vec<AnyOperation> {
let mut dl_modifying_plugins_no_deps: Vec<AnyOperation> = vec![];
@@ -370,7 +362,6 @@ impl Transaction {
/// Removals of packages should be executed before installations in
/// case two packages resolve to the same path (due to custom installers)
///
- /// @param OperationInterface[] $operations
/// @return OperationInterface[] reordered operation list
fn move_uninstalls_to_front(&self, mut operations: Vec<AnyOperation>) -> Vec<AnyOperation> {
let mut uninst_ops: Vec<AnyOperation> = vec![];