infer_clone/website/static/odoc/next/infer/Integration/Help/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Help (infer.Integration.Help)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">Integration</a> &#x00BB; Help</nav><h1>Module <code>Integration.Help</code></h1></header><dl><dt class="spec value" id="val-list_checkers"><a href="#val-list_checkers" class="anchor"></a><code><span class="keyword">val</span> list_checkers : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>print the list of all checkers</p></dd></dl><dl><dt class="spec value" id="val-list_issue_types"><a href="#val-list_issue_types" class="anchor"></a><code><span class="keyword">val</span> list_issue_types : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>print the list of all known issue types</p></dd></dl><dl><dt class="spec value" id="val-show_checkers"><a href="#val-show_checkers" class="anchor"></a><code><span class="keyword">val</span> show_checkers : <span><a href="../../IBase/Checker/index.html#type-t">IBase.Checker.t</a> list</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>show information about the given checkers</p></dd></dl><dl><dt class="spec value" id="val-show_issue_types"><a href="#val-show_issue_types" class="anchor"></a><code><span class="keyword">val</span> show_issue_types : <span><a href="../../IBase/IssueType/index.html#type-t">IBase.IssueType.t</a> list</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>show information about the given issue_types</p></dd></dl><dl><dt class="spec value" id="val-write_website"><a href="#val-write_website" class="anchor"></a><code><span class="keyword">val</span> write_website : <span>website_root:string</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>generate files for the fbinfer.com website</p></dd></dl><dl><dt class="spec value" id="val-abs_url_of_issue_type"><a href="#val-abs_url_of_issue_type" class="anchor"></a><code><span class="keyword">val</span> abs_url_of_issue_type : string <span>&#45;&gt;</span> string</code></dt><dd><p>given an issue type unique ID, return the URL relative to the root of the website, e.g. <code>abs_url_of_issue_type &quot;NULL_DEREFERENCE&quot;</code> is <code>&quot;/docs/all-issue-types#null_dereference&quot;</code></p></dd></dl></div></body></html>
[website] make doc-publish Summary: New website! Now with one page per checker, and only one page containing all issue types for easy tooling. Each checker page also lists the issue types it can report. For now only issue types with documentation appear in either page, filling these up is still TODO. Reviewed By: mityal Differential Revision: D21934465 fbshipit-source-id: 82ae1e417 5 years ago				`<!DOCTYPE html>`
make new-website-version Summary: Update documentation and add a version for v1.0.0. Reviewed By: martintrojer Differential Revision: D24191031 fbshipit-source-id: 0a57c693e 4 years ago				<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Help (infer.Integration.Help)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> » <a href="../index.html">Integration</a> » Help</nav><h1>Module <code>Integration.Help</code></h1></header><dl><dt class="spec value" id="val-list_checkers"><a href="#val-list_checkers" class="anchor"></a><code><span class="keyword">val</span> list_checkers : unit <span>-></span> unit</code></dt><dd><p>print the list of all checkers</p></dd></dl><dl><dt class="spec value" id="val-list_issue_types"><a href="#val-list_issue_types" class="anchor"></a><code><span class="keyword">val</span> list_issue_types : unit <span>-></span> unit</code></dt><dd><p>print the list of all known issue types</p></dd></dl><dl><dt class="spec value" id="val-show_checkers"><a href="#val-show_checkers" class="anchor"></a><code><span class="keyword">val</span> show_checkers : <span><a href="../../IBase/Checker/index.html#type-t">IBase.Checker.t</a> list</span> <span>-></span> unit</code></dt><dd><p>show information about the given checkers</p></dd></dl><dl><dt class="spec value" id="val-show_issue_types"><a href="#val-show_issue_types" class="anchor"></a><code><span class="keyword">val</span> show_issue_types : <span><a href="../../IBase/IssueType/index.html#type-t">IBase.IssueType.t</a> list</span> <span>-></span> unit</code></dt><dd><p>show information about the given issue_types</p></dd></dl><dl><dt class="spec value" id="val-write_website"><a href="#val-write_website" class="anchor"></a><code><span class="keyword">val</span> write_website : <span>website_root:string</span> <span>-></span> unit</code></dt><dd><p>generate files for the fbinfer.com website</p></dd></dl><dl><dt class="spec value" id="val-abs_url_of_issue_type"><a href="#val-abs_url_of_issue_type" class="anchor"></a><code><span class="keyword">val</span> abs_url_of_issue_type : string <span>-></span> string</code></dt><dd><p>given an issue type unique ID, return the URL relative to the root of the website, e.g. <code>abs_url_of_issue_type "NULL_DEREFERENCE"</code> is <code>"/docs/all-issue-types#null_dereference"</code></p></dd></dl></div></body></html>