Issue #2540136 by Shreya Shetty, rang501, chx, priya.chat: Improve ContextualLinkInterface doxygen

2016-02-17 11:27:14 +09:00 · 2016-02-17 11:27:14 +09:00 · 9a9770c4ec
parent ae8270742e
commit 9a9770c4ec
1 changed files with 8 additions and 0 deletions
--- a/core/lib/Drupal/Core/Menu/ContextualLinkInterface.php
+++ b/core/lib/Drupal/Core/Menu/ContextualLinkInterface.php
@ -9,6 +9,14 @@ namespace Drupal\Core\Menu;

 /**
 * Defines a contextual link plugin.
+ *
+ * Contextual links by default are in the module_name.links.contextual.yml
+ * file. These YAML files contain a list of contextual link plugin definitions,
+ * keyed by the plugin ID. Each definition must define a route_name and a group
+ * and might define title, options, and weight. See the getter methods on this
+ * interface for an explanation of each.
+ *
+ * @ingroup menu
 */
 interface ContextualLinkInterface {