Update snippet and doc gen parsers

googleapis · Jun 16, 2017 · 9c4b04b · 9c4b04b
1 parent a518c92
commit 9c4b04b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/dev/src/DocGenerator/Parser/CodeParser.php b/dev/src/DocGenerator/Parser/CodeParser.php
@@ -242,11 +242,11 @@ private function buildMagicMethod($magicMethod)
         $docText = '';
         $examples = null;
 
-        $parts = explode('Example:', $fullDescription);
+        $parts = explode('Sample Code:', $fullDescription);
 
         $docText = $parts[0];
 
-        if (strpos($fullDescription, 'Example:') !== false) {
+        if (strpos($fullDescription, 'Sample Code:' . PHP_EOL) !== false) {
             $examples = $parts[1];
         }
 
@@ -600,10 +600,10 @@ private function buildLink($content)
 
     private function splitDescription($description)
     {
-        $parts = explode('Example:', $description);
+        $parts = explode('Sample Code:', $description);
         $examples = null;
 
-        if (strpos($description, 'Example:') !== false) {
+        if (strpos($description, 'Sample Code:' . PHP_EOL) !== false) {
             $examples = $parts[1];
         }
 

diff --git a/dev/src/Snippet/Parser/Parser.php b/dev/src/Snippet/Parser/Parser.php
@@ -27,7 +27,7 @@
 /**
  * A class for parsing code snippets from a class and its methods.
  *
- * Example:
+ * Sample Code:
  * ```
  * $parser = new Parser;
  * ```
@@ -39,7 +39,7 @@ class Parser
     /**
      * Get a snippet from a class.
      *
-     * Example:
+     * Sample Code:
      * ```
      * $snippet = $parser->classExample(Parser::class);
      * ```
@@ -72,7 +72,7 @@ public function classExample($class, $index = 0)
     /**
      * Get a snippet from a method.
      *
-     * Example:
+     * Sample Code:
      * ```
      * $snippet = $parser->methodExample(Parser::class, 'methodExample');
      * ```
@@ -111,7 +111,7 @@ public function methodExample($class, $method, $index = 0)
     /**
      * Retrieve all examples from a class Doc Block.
      *
-     * Example:
+     * Sample Code:
      * ```
      * $examples = $parser->examplesFromClass($parser);
      * ```
@@ -160,7 +160,7 @@ public function examplesFromClass($class)
     /**
      * Retrieve all examples from a method's Doc Block.
      *
-     * Example:
+     * Sample Code:
      * ```
      * $examples = $parser->examplesFromMethod($parser, 'examplesFromMethod');
      * ```
@@ -196,7 +196,7 @@ public function examplesFromMethod($class, $method)
     /**
      * Retrieve all examples from a class and its methods.
      *
-     * Example:
+     * Sample Code:
      * ```
      * $examples = $parser->allExamples($parser);
      * ```
@@ -224,7 +224,7 @@ public function allExamples($class)
     /**
      * Parse examples from a DocBlock object.
      *
-     * Example:
+     * Sample Code:
      * ```
      * // Yeah, this example is pretty useless.
      * $examples = $parser->examples($docBlock);
@@ -243,9 +243,9 @@ public function examples(DocBlock $docBlock, $fullyQualifiedName, $file, $line,
         //     print_r($return[0]->getTypes());exit;
         // }
 
-        $parts = explode('Example:', $text);
+        $parts = explode('Sample Code:', $text);
 
-        if (strpos($text, 'Example:') === false) {
+        if (strpos($text, 'Sample Code:' . PHP_EOL) === false) {
             return [];
         }