Test: Document test failures due to expected actual assertion mismatch

Those test, and more so, their specific 'expected' outcome are being
documented so that when they get fixed, it becomes evident what was
changed and why.

This is done in order to make it easier to reason about what went wrong
and whether main source code needs to be updated as well, that is, since
there was no other explicit change but the 'minSdkVersion' to '24'
update that caused those failures.

Author: ParaskP7

aztec/src/test/kotlin/org/wordpress/aztec/AztecToolbarTest.kt

@@ -433,6 +433,16 @@ class AztecToolbarTest {
         italicButton.performClick()
         Assert.assertTrue(boldButton.isChecked)
         editText.append("bolditalic")
+        /**
+         * <strong>
+         *     bold
+         * </strong>
+         * <strong>
+         *     <em>
+         *         bolditalic
+         *     </em>
+         * </strong>
+         */
         Assert.assertEquals("<strong>bold</strong><strong><em>bolditalic</em></strong>", editText.toHtml())
         boldButton.performClick()
         Assert.assertFalse(boldButton.isChecked)

aztec/src/test/kotlin/org/wordpress/aztec/LinkTest.kt

@@ -49,6 +49,25 @@ class LinkTest {
         editText.setSelection(4)
         editText.link("http://wordpress.com", "WordPress")
         // Still valid, but order of b and del is switched here for some reason.
+        /**
+         * <b>
+         *     <s>
+         *         left
+         *     </s>
+         * </b>
+         * <b>
+         *     <s>
+         *         <a href="http://wordpress.com">
+         *             WordPress
+         *         </a>
+         *     </s>
+         * </b>
+         * <s>
+         *     <i>
+         *         right
+         *     </i>
+         * </s>
+         */
         Assert.assertEquals("<b><s>left</s></b><b><s><a href=\"http://wordpress.com\">WordPress</a></s></b><s><i>right</i></s>", editText.toHtml())
     }
 
@@ -160,6 +179,16 @@ class LinkTest {
         editText.setSelection(0, editText.length())
 
         editText.link("http://automattic.com", editText.getSelectedText())
+        /**
+         * <a href="http://automattic.com">
+         *     FirstUrl Hello
+         * </a>
+         * <a href="http://automattic.com">
+         *     <b>
+         *         SecondUrl
+         *     </b>
+         * </a>
+         */
         Assert.assertEquals("<a href=\"http://automattic.com\">FirstUrl Hello </a>" +
                 "<a href=\"http://automattic.com\"><b>SecondUrl</b></a>", editText.toHtml())
     }