Issue #1332648 by sven.lauer, jhodgdon, xjm: Clean up API docs for co…

…ntextual module.
bholtsclaw · Nov 24, 2011 · e1616f4 · e1616f4
1 parent ccb1f60
commit e1616f4
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/modules/contextual/contextual-rtl.css b/modules/contextual/contextual-rtl.css
@@ -1,3 +1,7 @@
+/**
+ * @file
+ * Stylesheet specific to right-to-left languages.
+ */
 
 div.contextual-links-wrapper {
   left: 5px;

diff --git a/modules/contextual/contextual.css b/modules/contextual/contextual.css
@@ -1,3 +1,7 @@
+/**
+ * @file
+ * Stylesheet for the Contextual module.
+ */
 
 /**
  * Contextual links regions.

diff --git a/modules/contextual/contextual.js b/modules/contextual/contextual.js
@@ -1,9 +1,14 @@
+/**
+ * @file
+ * Attaches behaviors for the Contextual module.
+ */
+
 (function ($) {
 
 Drupal.contextualLinks = Drupal.contextualLinks || {};
 
 /**
- * Attach outline behavior for regions associated with contextual links.
+ * Attaches outline behavior for regions associated with contextual links.
  */
 Drupal.behaviors.contextualLinks = {
   attach: function (context) {

diff --git a/modules/contextual/contextual.module b/modules/contextual/contextual.module
@@ -77,7 +77,7 @@ function contextual_element_info() {
 }
 
 /**
- * Template variable preprocessor for contextual links.
+ * Implements hook_preprocess().
  *
  * @see contextual_pre_render_links()
  */
@@ -132,6 +132,7 @@ function contextual_preprocess(&$variables, $hook) {
  *   A renderable array representing contextual links.
  *
  * @see menu_contextual_links()
+ * @see contextual_element_info()
  */
 function contextual_pre_render_links($element) {
   // Retrieve contextual menu links.