benchmark: Make sure constructors are parsed correctly for docs. [jdd…

…alton]
bestiejs · Jan 12, 2011 · 0d8b18d · 0d8b18d
1 parent bad1e69
commit 0d8b18d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 11 deletions.
diff --git a/docs/benchmark.md b/docs/benchmark.md
@@ -90,7 +90,7 @@
 * [`Benchmark.Suite#run`](#run)
 
 # Benchmark
-## <a name="Benchmark" href="https://github.com/mathiasbynens/benchmark.js/blob/master/benchmark.js#L125" title="View in source">Benchmark</a>
+## <a name="Benchmark" href="https://github.com/mathiasbynens/benchmark.js/blob/master/benchmark.js#L125" title="View in source">Benchmark(name, fn, options)</a>
 Benchmark constructor.
 <sup><code>[&#9650;][1]</code></sup>
 
@@ -630,7 +630,7 @@ Displays relevant benchmark information when coerced to a string.
 
 
 # Benchmark.Suite
-## <a name="Suite" href="https://github.com/mathiasbynens/benchmark.js/blob/master/benchmark.js#L178" title="View in source">Benchmark.Suite</a>
+## <a name="Suite" href="https://github.com/mathiasbynens/benchmark.js/blob/master/benchmark.js#L178" title="View in source">Benchmark.Suite(options)</a>
 Suite constructor.
 <sup><code>[&#9650;][1]</code></sup>
 

diff --git a/docs/parse.php b/docs/parse.php
@@ -48,8 +48,7 @@ function parse($filepath) {
 
       // parse @member
       preg_match("/@member ([^\n]+)/", $entry, $members);
-      $members = array_pop($members);
-      if ($members) {
+      if ($members = array_pop($members)) {
         $members = preg_split("/,\s*/", $members);
       }
       if ($isCtor) {
@@ -78,8 +77,7 @@ function parse($filepath) {
 
         // parse #{call}
         preg_match("#\*/\s*(?:function ([^{]*)|(?:". $member ."\.)?([^:=,]*))#", $entry, $call);
-        $call = array_pop($call);
-        if ($call) {
+        if ($call = array_pop($call)) {
           $call = trim(trim($call), "'");
         }
 
@@ -99,16 +97,14 @@ function parse($filepath) {
 
         // parse #{desc}
         preg_match("#/\*\*([^@]+)#", $entry, $desc);
-        $desc = array_pop($desc);
-        if ($desc) {
+        if ($desc = array_pop($desc)) {
           $desc = preg_replace("/\n\s*\*\s*/", "\n", $desc);
           $desc = ($type == "Function" ? "" : "(" . $type . "): ") . trim($desc);
         }
 
         // parse @example
         preg_match("#@example([\s\S]*)?(?=\*\s\@[a-z]|\*/)#", $entry, $example);
-        $example = array_pop($example);
-        if ($example) {
+        if ($example = array_pop($example)) {
           $example = "    " . trim(preg_replace("/\n\s*\* ?/", "\n    ", $example));
         }
 
@@ -246,9 +242,11 @@ function parse($filepath) {
           // description
           if ($entry["name"]) {
             if ($type == "ctor") {
+              // clip "call"
+              $entry["call"] = substr($entry["call"], strpos($entry["call"], "("));
               $result[] = interpolate(
                 "## <a name=\"#{hash}\" href=\"#{link}\" title=\"View in source\">" .
-                "#{member}</a>\n#{desc}\n<sup><code>[&#9650;][1]</code></sup>", $entry);
+                "#{member}#{call}</a>\n#{desc}\n<sup><code>[&#9650;][1]</code></sup>", $entry);
             } else {
               $result[] = interpolate(
                 "## <a name=\"#{hash}\" href=\"#{link}\" title=\"View in source\">" .