Skip to content

Commit c56eb44

Browse files
authored
Merge pull request #12767 from google/infrastructure/11887-enforce-doctag-descriptions
Infrastructure/11887 - Enforce comments on @param and @return tags within PHP docblocks
2 parents 96bedc8 + ae375fd commit c56eb44

153 files changed

Lines changed: 505 additions & 3 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

codegen/Composer.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
* phpcs:disable WordPress.WP.AlternativeFunctions
1111
* phpcs:disable WordPress.PHP.DiscouragedPHPFunctions
1212
* phpcs:disable WordPressVIPMinimum
13+
*
14+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
1315
*/
1416

1517
namespace Google\Site_Kit\Codegen;

includes/Context.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit;

includes/Core/Admin/Dashboard.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Admin;

includes/Core/Assets/Assets.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Assets;

includes/Core/Assets/Script.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Assets;

includes/Core/Authentication/Authentication.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Authentication;

includes/Core/Authentication/Credentials.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Authentication;

includes/Core/Authentication/Exception/Insufficient_Scopes_Exception.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2021 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Authentication\Exception;

includes/Core/Authentication/Guards/Site_Connected_Guard.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2024 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Authentication\Guards;

includes/Core/Authentication/Guards/Using_Proxy_Connection_Guard.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* @copyright 2024 Google LLC
77
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
88
* @link https://sitekit.withgoogle.com
9+
*
10+
* phpcs:disable PHPCS.Commenting.RequireDocTagDescription -- Pre-existing violations; tracked for follow-up cleanup.
911
*/
1012

1113
namespace Google\Site_Kit\Core\Authentication\Guards;

0 commit comments

Comments
 (0)