Skip to content

Commit 1f6279f

Browse files
authored
Merge pull request #43031 from nextcloud/fix/fix-throw-phpdoc-in-setupresult
2 parents cff36b7 + a2eacf4 commit 1f6279f

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

lib/public/SetupCheck/SetupResult.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ class SetupResult implements \JsonSerializable {
4747
/**
4848
* @brief Private constructor, use success()/info()/warning()/error() instead
4949
* @param self::SUCCESS|self::INFO|self::WARNING|self::ERROR $severity
50+
* @throws \OCP\RichObjectStrings\InvalidObjectExeption
5051
* @since 28.0.0
5152
* @since 28.0.2 Optional parameter ?array $descriptionParameters
5253
* @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption
@@ -66,8 +67,10 @@ private function __construct(
6667
* @brief Create a success result object
6768
* @param ?string $description Translated detailed description to display to the user
6869
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
70+
* @throws \OCP\RichObjectStrings\InvalidObjectExeption
6971
* @since 28.0.0
7072
* @since 28.0.2 Optional parameter ?array $descriptionParameters
73+
* @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption
7174
*/
7275
public static function success(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
7376
return new self(self::SUCCESS, $description, $descriptionParameters, $linkToDoc);
@@ -77,8 +80,10 @@ public static function success(?string $description = null, ?string $linkToDoc =
7780
* @brief Create an info result object
7881
* @param ?string $description Translated detailed description to display to the user
7982
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
83+
* @throws \OCP\RichObjectStrings\InvalidObjectExeption
8084
* @since 28.0.0
8185
* @since 28.0.2 Optional parameter ?array $descriptionParameters
86+
* @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption
8287
*/
8388
public static function info(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
8489
return new self(self::INFO, $description, $descriptionParameters, $linkToDoc);
@@ -88,8 +93,10 @@ public static function info(?string $description = null, ?string $linkToDoc = nu
8893
* @brief Create a warning result object
8994
* @param ?string $description Translated detailed description to display to the user
9095
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
96+
* @throws \OCP\RichObjectStrings\InvalidObjectExeption
9197
* @since 28.0.0
9298
* @since 28.0.2 Optional parameter ?array $descriptionParameters
99+
* @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption
93100
*/
94101
public static function warning(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
95102
return new self(self::WARNING, $description, $descriptionParameters, $linkToDoc);
@@ -99,8 +106,10 @@ public static function warning(?string $description = null, ?string $linkToDoc =
99106
* @brief Create an error result object
100107
* @param ?string $description Translated detailed description to display to the user
101108
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
109+
* @throws \OCP\RichObjectStrings\InvalidObjectExeption
102110
* @since 28.0.0
103111
* @since 28.0.2 Optional parameter ?array $descriptionParameters
112+
* @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption
104113
*/
105114
public static function error(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
106115
return new self(self::ERROR, $description, $descriptionParameters, $linkToDoc);

0 commit comments

Comments
 (0)