Add function documentation to private functions

umherirrender · WMDE bot · commit c64b7fd9df65 · 2025-02-27T12:37:47.000Z
Bug: T330644
Depends-On: I2914498869ee8dbee20ca8196ac70b7b70e83b44
Depends-On: I69fb434d5840af45977d0fbc8026faab274e3866
Depends-On: I9db4e5fa87a6d84300c5f9f4e3eddf497ec31739
Change-Id: I1c42b94b1b6683b78b2b4d326bdbecc3353935d3
diff --git a/src/ByPropertyIdGrouper.php b/src/ByPropertyIdGrouper.php
@@ -33,6 +33,9 @@ public function __construct( $propertyIdProviders ) {
 		$this->indexPropertyIdProviders( $propertyIdProviders );
 	}
 
+	/**
+	 * @param PropertyIdProvider[]|Traversable $propertyIdProviders
+	 */
 	private function assertArePropertyIdProviders( $propertyIdProviders ) {
 		if ( !is_iterable( $propertyIdProviders ) ) {
 			throw new InvalidArgumentException( '$propertyIdProviders must be an array or an instance of Traversable' );

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ public function __construct( $propertyIdProviders ) {`
`33`	`33`	`$this->indexPropertyIdProviders( $propertyIdProviders );`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /**`
	`37`	`+ * @param PropertyIdProvider[]\|Traversable $propertyIdProviders`
	`38`	`+ */`
`36`	`39`	`private function assertArePropertyIdProviders( $propertyIdProviders ) {`
`37`	`40`	`if ( !is_iterable( $propertyIdProviders ) ) {`
`38`	`41`	`throw new InvalidArgumentException( '$propertyIdProviders must be an array or an instance of Traversable' );`