Changeset 47122 for trunk/tests/phpunit/tests/formatting/MakeClickable.php

Timestamp:

01/29/2020 12:43:23 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/tests/formatting/MakeClickable.php (modified) (9 diffs)

trunk/tests/phpunit/tests/formatting/MakeClickable.php

@@ -37 +37 @@
         }
 
-        // tests that make_clickable will not link trailing periods, commas and
-        // (semi-)colons in URLs with protocol (i.e. http://wordpress.org)
+        /**
+         * Tests that make_clickable() will not link trailing periods, commas,
+         * and (semi-)colons in URLs with protocol (i.e. http://wordpress.org).
+         */
         function test_strip_trailing_with_protocol() {
                 $urls_before   = array(
@@ -62 +64 @@
         }
 
-        // tests that make_clickable will not link trailing periods, commas and
-        // (semi-)colons in URLs with protocol (i.e. http://wordpress.org)
+        /**
+         * Tests that make_clickable() will not link trailing periods, commas,
+         * and (semi-)colons in URLs with protocol (i.e. http://wordpress.org).
+         */
         function test_strip_trailing_with_protocol_nothing_afterwards() {
                 $urls_before   = array(
@@ -89 +93 @@
         }
 
-        // tests that make_clickable will not link trailing periods, commas and
-        // (semi-)colons in URLs without protocol (i.e. www.wordpress.org)
+        /**
+         * Tests that make_clickable() will not link trailing periods, commas,
+         * and (semi-)colons in URLs without protocol (i.e. www.wordpress.org).
+         */
         function test_strip_trailing_without_protocol() {
                 $urls_before   = array(
@@ -114 +120 @@
         }
 
-        // tests that make_clickable will not link trailing periods, commas and
-        // (semi-)colons in URLs without protocol (i.e. www.wordpress.org)
+        /**
+         * Tests that make_clickable() will not link trailing periods, commas,
+         * and (semi-)colons in URLs without protocol (i.e. www.wordpress.org).
+         */
         function test_strip_trailing_without_protocol_nothing_afterwards() {
                 $urls_before   = array(
@@ -139 +147 @@
         }
 
-        // #4570
+        /**
+         * @ticket 4570
+         */
         function test_iri() {
                 $urls_before   = array(
@@ -156 +166 @@
         }
 
-        // #10990
+        /**
+         * @ticket 10990
+         */
         function test_brackets_in_urls() {
                 $urls_before   = array(
@@ -191 +203 @@
         }
 
-        // Based on a real comments which were incorrectly linked. #11211
+        /**
+         * Based on real comments which were incorrectly linked.
+         *
+         * @ticket 11211
+         */
         function test_real_world_examples() {
                 $urls_before   = array(
@@ -210 +226 @@
         }
 
-        // #14993
+        /**
+         * @ticket 14993
+         */
         function test_twitter_hash_bang() {
                 $urls_before   = array(
@@ -350 +368 @@
                 $in = array(
                         'Some text with a link <a href="http://example.com">http://example.com</a>',
-                        //'<a href="http://wordpress.org">This is already a link www.wordpress.org</a>', // fails in 3.3.1 too
+                        // '<a href="http://wordpress.org">This is already a link www.wordpress.org</a>', // Fails in 3.3.1 too.
                 );
                 foreach ( $in as $text ) {