Merge pull request #17557 from ngo360/master

[civicrm-core.git] / Civi / Api4 / Route.php

diff --git a/Civi/Api4/Route.php b/Civi/Api4/Route.php
index e1c5b779c5ef3c250c9493d047c2fa856d4a5d0b..f3d36bc61cbce6315a0bd6ee53861a09a9f14538 100644 (file)
--- a/Civi/Api4/Route.php
+++ b/Civi/Api4/Route.php
@@ -22,6 +22,17 @@ namespace Civi\Api4;
 
 use Civi\Api4\Generic\BasicGetFieldsAction;
 
+/**
+ * CiviCRM menu route.
+ *
+ * Provides page routes registered in the CiviCRM menu system.
+ *
+ * Note: this is a read-only api as routes are set via xml files and hooks.
+ *
+ * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterMenu/
+ *
+ * @package Civi\Api4
+ */
 class Route extends \Civi\Api4\Generic\AbstractEntity {
 
   /**