From d0cab0e97e10cd58e68e025bf4bd3415b7d117dd Mon Sep 17 00:00:00 2001
From: Lars Toomre <ltoomre@23809.no-reply.drupal.org>
Date: Tue, 9 Oct 2012 11:05:32 -0400
Subject: [PATCH] Issue 1807612-1 by Lars Toomre: Clean up of API docs for Ban
 module.

---
 core/modules/ban/ban.admin.inc                     |    9 ++++++---
 .../lib/Drupal/ban/Tests/IpAddressBlockingTest.php |    5 ++++-
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/core/modules/ban/ban.admin.inc b/core/modules/ban/ban.admin.inc
index d7940f9..69d193a 100644
--- a/core/modules/ban/ban.admin.inc
+++ b/core/modules/ban/ban.admin.inc
@@ -9,8 +9,10 @@
  * Page callback; Displays banned IP addresses.
  *
  * @param string $default_ip
- *   (optional) IP address to be passed on to drupal_get_form() for
- *   use as the default value of the IP address form field.
+ *   (optional) IP address to be passed on to drupal_get_form() for use as the
+ *   default value of the IP address form field. Defaults to an empty string.
+ *
+ * @see ban_menu()
  */
 function ban_admin_page($default_ip = '') {
   $rows = array();
@@ -41,8 +43,8 @@ function ban_admin_page($default_ip = '') {
  * @param string $default_ip
  *   An IP address to ban, used as default value.
  *
- * @see ban_ip_form_validate()
  * @see ban_ip_form_submit()
+ * @see ban_ip_form_validate()
  *
  * @ingroup forms
  */
@@ -102,6 +104,7 @@ function ban_ip_form_submit($form, &$form_state) {
  *   The IP address record to unban, as provided by ban_ip_load().
  *
  * @see ban_ip_delete_submit()
+ * @see ban_menu()
  */
 function ban_ip_delete_form($form, &$form_state, array $ban_ip) {
   $form['ban_ip'] = array(
diff --git a/core/modules/ban/lib/Drupal/ban/Tests/IpAddressBlockingTest.php b/core/modules/ban/lib/Drupal/ban/Tests/IpAddressBlockingTest.php
index 39203d9..843d2c1 100644
--- a/core/modules/ban/lib/Drupal/ban/Tests/IpAddressBlockingTest.php
+++ b/core/modules/ban/lib/Drupal/ban/Tests/IpAddressBlockingTest.php
@@ -9,6 +9,9 @@
 
 use Drupal\simpletest\WebTestBase;
 
+/**
+ * Tests the banning of an IP address functionality.
+ */
 class IpAddressBlockingTest extends WebTestBase {
 
   /**
@@ -27,7 +30,7 @@ public static function getInfo() {
   }
 
   /**
-   * Test a variety of user input to confirm correct validation and saving of data.
+   * Tests user input to confirm correct validation and saving of data.
    */
   function testIPAddressValidation() {
     // Create user.
-- 
1.7.6.msysgit.0