Adding promise example to api docs

aberesniewicz · May 21, 2015 · cd6f849 · cd6f849
1 parent 0d1e105
commit cd6f849
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/build/docs/classes/DocsBuilder.php b/build/docs/classes/DocsBuilder.php
@@ -155,7 +155,7 @@ private function createHtmlForToc(Service $service, array $operations)
         $html->open('ul', 'methods-summary');
         foreach ($operations as $opName => $operation) {
             $item = '<a class="method-summary-link" href="#' . $html->slug($opName)
-                . '"><strong>' . "{$opName}</strong></a>";
+                . '"><strong>' . "{$opName}</strong> ( array \$params = [] )</a>";
 
             if ($description = $service->docs->getOperationDocs($opName)) {
                 $shortened = strip_tags($description);
@@ -312,7 +312,12 @@ private function createHtmlForOperation(Service $service, $name, Operation $oper
         $html->section(3, $html->glyph('cog') . ' ' . $name, null, 'method-title');
 
         // Code
-        $html->elem('pre', 'opcode', '$result = $client-&gt;<code>' . lcfirst($name) . '</code>([/* ... */]);');
+        $html->elem(
+            'pre',
+            'opcode',
+            '$result = $client-&gt;<code>' . lcfirst($name) . '</code>([/* ... */]);' . "\n"
+            . '$promise = $client-&gt;<code>' . lcfirst($name) . 'Async</code>([/* ... */]);' . "\n"
+        );
 
         // Description
         if ($description = $service->docs->getOperationDocs($name)) {