If we fail to parse a code section, just ignore it and don't highlight

hhvm · Jun 27, 2019 · c5f101a · c5f101a
1 parent 16b0d4c
commit c5f101a
Show file tree

Hide file tree

Showing 137 changed files with 1,634 additions and 406 deletions.
diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.__construct.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.__construct.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::__construct</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,10 +44,10 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::__construct()</h1>
 <p>Create and parse a documentation block</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-ConstructToken">__construct</span><span class="hs-LeftParenToken">(
-</span><span class="hs-ListItem"><span class="hs-ParameterDeclaration"><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">  string </span></span><span class="hs-VariableToken">$rawDocBlock</span></span><span class="hs-CommaToken">,
-</span></span><span class="hs-RightParenToken">)</span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function __construct(
+  string $rawDocBlock,
+);
+</code></pre>
 <h2>Parameters</h2>
 <ul>
 <li><code>string $rawDocBlock</code> A raw documentation block, as returned by reflection or

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getDescription.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getDescription.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::getDescription</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,8 +44,8 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::getDescription()</h1>
 <p>Get the description of the item being documented</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">getDescription</span><span class="hs-LeftParenToken">(</span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-NullableTypeSpecifier"><span class="hs-QuestionToken">?</span><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string</span></span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function getDescription(): ?string;
+</code></pre>
 <p>This is anything that is not an <code>@tag</code> or summary.</p>
 <h2>Returns</h2>
 <ul>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getParameterInfo.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getParameterInfo.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::getParameterInfo</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,8 +44,8 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::getParameterInfo()</h1>
 <p>Return information on function parameters from <code>@param</code> tags</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">getParameterInfo</span><span class="hs-LeftParenToken">(</span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-DictionaryTypeSpecifier"><span class="hs-DictToken">dict</span><span class="hs-LessThanToken">&lt;</span><span class="hs-ListItem"><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string</span></span><span class="hs-CommaToken">, </span></span><span class="hs-ListItem"><span class="hs-SimpleTypeSpecifier"><span class="hs-QualifiedName"><span class="hs-ListItem"><span class="hs-NameToken">Facebook</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">HHAPIDoc</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">DocBlock</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">ParameterInfo</span></span></span></span></span><span class="hs-GreaterThanToken">&gt;</span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function getParameterInfo(): dict&lt;string, Facebook\HHAPIDoc\DocBlock\ParameterInfo&gt;;
+</code></pre>
 <h2>Returns</h2>
 <ul>
 <li><code>dict&lt;string, Facebook\HHAPIDoc\DocBlock\ParameterInfo&gt;</code></li>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getReturnInfo.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getReturnInfo.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::getReturnInfo</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,8 +44,8 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::getReturnInfo()</h1>
 <p>Get the return information for a function</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">getReturnInfo</span><span class="hs-LeftParenToken">(</span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-VectorTypeSpecifier"><span class="hs-VecToken">vec</span><span class="hs-LessThanToken">&lt;</span><span class="hs-SimpleTypeSpecifier"><span class="hs-QualifiedName"><span class="hs-ListItem"><span class="hs-NameToken">Facebook</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">HHAPIDoc</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">DocBlock</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">ReturnInfo</span></span></span></span><span class="hs-GreaterThanToken">&gt;</span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function getReturnInfo(): vec&lt;Facebook\HHAPIDoc\DocBlock\ReturnInfo&gt;;
+</code></pre>
 <p>There may be multiple <code>ReturnInfo</code> results, if there are multiple
 <code>@return</code> tags in the docblock.</p>
 <h2>Returns</h2>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getSummary.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getSummary.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::getSummary</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,8 +44,8 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::getSummary()</h1>
 <p>Get the summary of the item being documented</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">getSummary</span><span class="hs-LeftParenToken">(</span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-NullableTypeSpecifier"><span class="hs-QuestionToken">?</span><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string</span></span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function getSummary(): ?string;
+</code></pre>
 <p>This is the content of the doccomment until the first empty line or period.</p>
 <p>In the future, this may parse the doccomment as markdown, and return
 the content until the first empty line <em>or plain text</em> period.</p>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getTagsByName.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.getTagsByName.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::getTagsByName</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,10 +44,10 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::getTagsByName()</h1>
 <p>Return the content of all tags with the specified name</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">getTagsByName</span><span class="hs-LeftParenToken">(
-</span><span class="hs-ListItem"><span class="hs-ParameterDeclaration"><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">  string </span></span><span class="hs-VariableToken">$name</span></span><span class="hs-CommaToken">,
-</span></span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-VectorTypeSpecifier"><span class="hs-VecToken">vec</span><span class="hs-LessThanToken">&lt;</span><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string</span></span><span class="hs-GreaterThanToken">&gt;</span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function getTagsByName(
+  string $name,
+): vec&lt;string&gt;;
+</code></pre>
 <p>For example, <a href="class.Facebook.HHAPIDoc.DocBlock.DocBlock.getTagsByName.html"><code>getTagsByName('@param')</code></a> will return all
 <code>@param</code> tags.</p>
 <h2>Parameters</h2>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -41,13 +50,13 @@ <h1>Facebook\HHAPIDoc\DocBlock\DocBlock</h1>
 JavaDoc style tags are supported, such as <code>@param</code>, <code>@see</code>, and
 <code>@return</code>.</p>
 <h2>Interface Synopsis</h2>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-NamespaceDeclaration"><span class="hs-NamespaceToken">namespace </span><span class="hs-QualifiedName"><span class="hs-ListItem"><span class="hs-NameToken">Facebook</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">HHAPIDoc</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">DocBlock</span></span></span><span class="hs-NamespaceEmptyBody"><span class="hs-SemicolonToken">;
+<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-NamespaceDeclaration"><span class="hs-NamespaceToken">namespace </span><span class="hs-QualifiedName"><span class="hs-ListItem"><span class="hs-NameToken">Facebook</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">HHAPIDoc</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">DocBlock</span></span></span><span class="hs-NamespaceEmptyBody"><span class="hs-SemicolonToken">;
 </span></span></span><span class="hs-ClassishDeclaration"><span class="hs-FinalToken">
 final </span><span class="hs-ClassToken">class </span><span class="hs-NameToken">DocBlock </span><span class="hs-ClassishBody"><span class="hs-LeftBraceToken">{</span><span class="hs-ErrorSyntax"><span class="hs-DotDotDotToken">...</span></span><span class="hs-RightBraceToken">}</span></span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
 
 <h3>Public Methods</h3>
 <ul>
-<li><a href="class.Facebook.HHAPIDoc.DocBlock.DocBlock.nullable.html"><code>::nullable(?string $comment): ?\this</code></a><br />
+<li><a href="class.Facebook.HHAPIDoc.DocBlock.DocBlock.nullable.html"><code>::nullable(?string $comment): ?this</code></a><br />
 Create a new instance if a comment is provided</li>
 <li><a href="class.Facebook.HHAPIDoc.DocBlock.DocBlock.__construct.html"><code>-&gt;__construct(string $rawDocBlock)</code></a><br />
 Create and parse a documentation block</li>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.nullable.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.nullable.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::nullable</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,10 +44,10 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::nullable()</h1>
 <p>Create a new instance if a comment is provided</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionStaticStatement"><span class="hs-StaticToken">static </span><span class="hs-ListItem"><span class="hs-StaticDeclarator"></span></span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">nullable</span><span class="hs-LeftParenToken">(
-</span><span class="hs-ListItem"><span class="hs-ParameterDeclaration"><span class="hs-NullableTypeSpecifier"><span class="hs-QuestionToken">  ?</span><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string </span></span></span><span class="hs-VariableToken">$comment</span></span><span class="hs-CommaToken">,
-</span></span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-NullableTypeSpecifier"><span class="hs-QuestionToken">?</span><span class="hs-SimpleTypeSpecifier"><span class="hs-ThisToken">this</span></span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public static function nullable(
+  ?string $comment,
+): ?Facebook\HHAPIDoc\DocBlock\this;
+</code></pre>
 <h2>Parameters</h2>
 <ul>
 <li><code>?string $comment</code></li>

diff --git a/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.typeToTypes.html b/docs/class.Facebook.HHAPIDoc.DocBlock.DocBlock.typeToTypes.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocBlock\DocBlock::typeToTypes</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,10 +44,10 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocBlock\DocBlock::typeToTypes()</h1>
 <p>Convert a string type specifiction to a list of types</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-ProtectedToken">protected </span></span><span class="hs-FunctionStaticStatement"><span class="hs-StaticToken">static </span><span class="hs-ListItem"><span class="hs-StaticDeclarator"></span></span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-NameToken">typeToTypes</span><span class="hs-LeftParenToken">(
-</span><span class="hs-ListItem"><span class="hs-ParameterDeclaration"><span class="hs-NullableTypeSpecifier"><span class="hs-QuestionToken">  ?</span><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string </span></span></span><span class="hs-VariableToken">$type</span></span><span class="hs-CommaToken">,
-</span></span><span class="hs-RightParenToken">)</span><span class="hs-ColonToken">: </span><span class="hs-VectorTypeSpecifier"><span class="hs-VecToken">vec</span><span class="hs-LessThanToken">&lt;</span><span class="hs-SimpleTypeSpecifier"><span class="hs-StringToken">string</span></span><span class="hs-GreaterThanToken">&gt;</span></span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">protected static function typeToTypes(
+  ?string $type,
+): vec&lt;string&gt;;
+</code></pre>
 <p>For example:</p>
 <ul>
 <li><code>'string'</code> -&gt; <code>vec['string']</code></li>

diff --git a/docs/class.Facebook.HHAPIDoc.DocumentationBuilder.__construct.html b/docs/class.Facebook.HHAPIDoc.DocumentationBuilder.__construct.html
@@ -2,6 +2,15 @@
 <head>
 <title>Facebook\HHAPIDoc\DocumentationBuilder::__construct</title>
 <style>
+/*
+ *  Copyright (c) 2018-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
 /* Keywords */
 
 .hs-FunctionToken,
@@ -35,10 +44,10 @@
 <body>
 <h1>Facebook\HHAPIDoc\DocumentationBuilder::__construct()</h1>
 <p>Create a new instance</p>
-<pre><code class="language-Hack"><span class="hs-Script"><span class="hs-MarkupSection"></span><span class="hs-ExpressionStatement"><span class="hs-PublicToken">public </span></span><span class="hs-FunctionDeclaration"><span class="hs-FunctionDeclarationHeader"><span class="hs-FunctionToken">function </span><span class="hs-ConstructToken">__construct</span><span class="hs-LeftParenToken">(
-</span><span class="hs-ListItem"><span class="hs-ParameterDeclaration"><span class="hs-SimpleTypeSpecifier"><span class="hs-QualifiedName"><span class="hs-ListItem"><span class="hs-NameToken">  Facebook</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">HHAPIDoc</span><span class="hs-BackslashToken">\</span></span><span class="hs-ListItem"><span class="hs-NameToken">DocumentationBuilderContext </span></span></span></span><span class="hs-VariableToken">$context</span></span><span class="hs-CommaToken">,
-</span></span><span class="hs-RightParenToken">)</span></span><span class="hs-SemicolonToken">;</span></span><span class="hs-EndOfFile"><span class="hs-EndOfFileToken"></span></span></span></code></pre>
-
+<pre><code class="language-Hack">public function __construct(
+  Facebook\HHAPIDoc\DocumentationBuilderContext $context,
+);
+</code></pre>
 <h2>Parameters</h2>
 <ul>
 <li><a href="class.Facebook.HHAPIDoc.DocumentationBuilderContext.html"><code>Facebook\HHAPIDoc\DocumentationBuilderContext</code></a><code> $context</code> Context such as desired output format</li>