Merge branch 'develop' into dobooth-patch-1

Author: tomreece

dev/tests/unit/Magento/FunctionalTestFramework/Test/Util/ActionGroupAnnotationExtractorTest.php

@@ -34,19 +34,13 @@ public function testActionGroupExtractAnnotations()
             "description" => [
                 "nodeName" => "description",
                 "value" => "someDescription"
-            ],
-            "page" => [
-                "nodeName" => "page",
-                "value" => "somePage"
             ]
         ];
         // Perform Test
         $extractor = new ActionGroupAnnotationExtractor();
         $returnedAnnotations = $extractor->extractAnnotations($actionGroupAnnotations, "fileName");
 
         // Asserts
-
-        $this->assertEquals("somePage", $returnedAnnotations['page']);
         $this->assertEquals("someDescription", $returnedAnnotations['description']);
     }
 
@@ -57,7 +51,7 @@ public function testActionGroupExtractAnnotations()
      */
     public function testActionGroupMissingAnnotations()
     {
-        // Action Group Data, missing page and description
+        // Action Group Data, missing description
         $testAnnotations = [];
         // Perform Test
         $extractor = new ActionGroupAnnotationExtractor();
@@ -70,7 +64,7 @@ public function testActionGroupMissingAnnotations()
             'DEPRECATION: Action Group File fileName is missing required annotations.',
             [
                 'actionGroup' => 'fileName',
-                'missingAnnotations' => "description, page"
+                'missingAnnotations' => "description"
             ]
         );
     }
@@ -83,7 +77,7 @@ public function testActionGroupMissingAnnotations()
      */
     public function testActionGroupMissingAnnotationsNoWarning()
     {
-        // Action Group Data, missing page and description
+        // Action Group Data, missing description
         $testAnnotations = [];
         // Perform Test
         $extractor = new ActionGroupAnnotationExtractor();

dev/tests/unit/Magento/FunctionalTestFramework/Util/DocGeneratorTest.php

@@ -23,7 +23,6 @@ class DocGeneratorTest extends MagentoTestCase
     public function testBasicCreateDocumentation()
     {
         $annotations = [
-            "page" => "somePage",
             "description" => "someDescription"
         ];
         $actionGroupUnderTest = (new ActionGroupObjectBuilder())
@@ -55,7 +54,6 @@ public function testBasicCreateDocumentation()
     public function testCreateDocumentationWithOverwrite()
     {
         $annotations = [
-            "page" => "somePage",
             "description" => "someDescription"
         ];
         $actionGroupUnderTest = (new ActionGroupObjectBuilder())
@@ -70,7 +68,6 @@ public function testCreateDocumentationWithOverwrite()
         );
 
         $annotations = [
-            "page" => "alteredPage",
             "description" => "alteredDescription"
         ];
         $actionGroupUnderTest = (new ActionGroupObjectBuilder())
@@ -102,7 +99,6 @@ public function testCreateDocumentationWithOverwrite()
     public function testCreateDocumentationNotCleanException()
     {
         $annotations = [
-            "page" => "somePage",
             "description" => "someDescription"
         ];
         $actionGroupUnderTest = (new ActionGroupObjectBuilder())

dev/tests/unit/Resources/alteredDocumentation.txt

@@ -1,16 +1,12 @@
 #Action Group Information
-This documentation contains a list of all action groups on the pages on which they start
+This documentation contains a list of all Action Groups.
 
-##List of Pages
-- [ alteredPage ](#alteredPage)
 ---
-<a name="alteredPage"></a>
-##alteredPage
-
 ###testActionGroupObject
-alteredDescription
+**Description**:
+- alteredDescription
 
-Located in:
+**Located In**:
 
 - filename
 ***

dev/tests/unit/Resources/basicDocumentation.txt

@@ -1,16 +1,12 @@
 #Action Group Information
-This documentation contains a list of all action groups on the pages on which they start
+This documentation contains a list of all Action Groups.
 
-##List of Pages
-- [ somePage ](#somePage)
 ---
-<a name="somePage"></a>
-##somePage
-
 ###testActionGroupObject
-someDescription
+**Description**:
+- someDescription
 
-Located in:
+**Located In**:
 
 - filename
 ***

src/Magento/FunctionalTestingFramework/Test/Util/ActionGroupAnnotationExtractor.php

@@ -14,8 +14,7 @@
 class ActionGroupAnnotationExtractor extends AnnotationExtractor
 {
     const ACTION_GROUP_REQUIRED_ANNOTATIONS = [
-        "description",
-        "page",
+        "description"
     ];
     const GENERATE_DOCS_COMMAND = 'generate:docs';
 

src/Magento/FunctionalTestingFramework/Test/etc/actionGroupSchema.xsd

@@ -34,7 +34,6 @@
                 <xs:complexType>
                     <xs:sequence>
                         <xs:element name="description"/>
-                        <xs:element name="page"/>
                     </xs:sequence>
                 </xs:complexType>
             </xs:element>

src/Magento/FunctionalTestingFramework/Util/DocGenerator.php

@@ -76,7 +76,8 @@ public function createDocumentation($annotatedObjects, $outputDir, $clean)
                     ?? 'NO_DESCRIPTION_SPECIFIED',
                 self::FILENAMES => $filenames,
                 ActionGroupObjectExtractor::ACTION_GROUP_ARGUMENTS => $arguments
-                ];
+            ];
+
             $pageGroups = array_merge_recursive(
                 $pageGroups,
                 [$annotations[ActionGroupObject::ACTION_GROUP_PAGE] ?? 'NO_PAGE_SPECIFIED' => [$name => $info]]
@@ -103,34 +104,28 @@ public function createDocumentation($annotatedObjects, $outputDir, $clean)
     private function transformToMarkdown($annotationList)
     {
         $markdown = "#Action Group Information" . PHP_EOL;
-        $markdown .= "This documentation contains a list of all" .
-            " action groups on the pages on which they start" .
+        $markdown .= "This documentation contains a list of all Action Groups." .
             PHP_EOL .
             PHP_EOL;
 
-        $markdown .= "##List of Pages" . PHP_EOL;
-        foreach ($annotationList as $group => $objects) {
-            $markdown .= "- [ $group ](#$group)" . PHP_EOL;
-        }
         $markdown .= "---" . PHP_EOL;
         foreach ($annotationList as $group => $objects) {
-            $markdown .= "<a name=\"$group\"></a>" . PHP_EOL;
-            $markdown .= "##$group" . PHP_EOL . PHP_EOL;
             foreach ($objects as $name => $annotations) {
                 $markdown .= "###$name" . PHP_EOL;
-                $markdown .= $annotations[actionGroupObject::ACTION_GROUP_DESCRIPTION] . PHP_EOL . PHP_EOL;
+                $markdown .= "**Description**:" . PHP_EOL;
+                $markdown .= "- " . $annotations[actionGroupObject::ACTION_GROUP_DESCRIPTION] . PHP_EOL . PHP_EOL;
                 if (!empty($annotations[ActionGroupObjectExtractor::ACTION_GROUP_ARGUMENTS])) {
-                    $markdown .= "Action Group Arguments:" . PHP_EOL . PHP_EOL;
+                    $markdown .= "**Action Group Arguments**:" . PHP_EOL . PHP_EOL;
                     $markdown .= "| Name | Type |" . PHP_EOL;
-                    $markdown .= "| --- | --- |" . PHP_EOL;
+                    $markdown .= "| ---- | ---- |" . PHP_EOL;
                     foreach ($annotations[ActionGroupObjectExtractor::ACTION_GROUP_ARGUMENTS] as $argument) {
                         $argumentName = $argument->getName();
                         $argumentType = $argument->getDataType();
                         $markdown .= "| $argumentName | $argumentType |" . PHP_EOL;
                     }
                     $markdown .= PHP_EOL;
                 }
-                $markdown .= "Located in:" . PHP_EOL;
+                $markdown .= "**Located In**:" . PHP_EOL;
                 foreach ($annotations[self::FILENAMES] as $filename) {
                     $relativeFilename = str_replace(MAGENTO_BP . DIRECTORY_SEPARATOR, "", $filename);
                     $markdown .= PHP_EOL .  "- $relativeFilename";