summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwn_ <invalid@email.com>2024-12-15 16:41:45 +0000
committerwn_ <invalid@email.com>2024-12-15 16:41:45 +0000
commit6f8f1b30d508dc3d2c3a067ca7fe2d161963ef5f (patch)
tree247c698e8023ec6cd7230ee1b17ce5a759292509
parentcfbbb9d714d7b5d59d3fb3e326b80f6cc88fbe23 (diff)
minor PHPDoc cleanup in PluginHost
-rw-r--r--classes/PluginHost.php4
1 files changed, 2 insertions, 2 deletions
diff --git a/classes/PluginHost.php b/classes/PluginHost.php
index bccf2ecc8..5f1d97f53 100644
--- a/classes/PluginHost.php
+++ b/classes/PluginHost.php
@@ -763,8 +763,8 @@ class PluginHost {
* Add a special (plugin-provided) feed
*
* @param int $cat_id only -1 (Feeds::CATEGORY_SPECIAL) is supported
- * @return false|positive-int false if $cat_id was not -1 (Feeds::CATEGORY_SPECIAL),
- * otherwise a positive integer ID that might change between executions
+ * @return false|int false if the feed wasn't added (e.g. $cat_id wasn't Feeds::CATEGORY_SPECIAL),
+ * otherwise an integer "feed ID" that might change between executions
*/
function add_feed(int $cat_id, string $title, string $icon, Plugin $sender): false|int {
if ($cat_id !== Feeds::CATEGORY_SPECIAL)