Merge pull request #927 from nojaf/fix-docs

Fix docs generation for .net core
fsharp · Feb 9, 2020 · ff4d182 · ff4d182
2 parents d12d208 + 4d4e42c
commit ff4d182
Show file tree

Hide file tree

Showing 590 changed files with 30,200 additions and 31,599 deletions.
diff --git a/docs/caches.html b/docs/caches.html
@@ -25,22 +25,21 @@
     <div class="container">
       <div class="masthead">
         <ul class="nav nav-pills pull-right">
-          <li><a href="http://fsharp.org">fsharp.org</a></li>
-          <li><a href="http://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
+          <li><a href="https://fsharp.org">fsharp.org</a></li>
+          <li><a href="https://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
         </ul>
         <h3 class="muted">F# Compiler Services</h3>
       </div>
       <hr />
       <div class="row">
         <div class="span9" id="main">
-
-<h1><a name="Compiler-Services-Notes-on-the-FSharpChecker-caches" class="anchor" href="#Compiler-Services-Notes-on-the-FSharpChecker-caches">Compiler Services: Notes on the FSharpChecker caches</a></h1>
+          <h1><a name="Compiler-Services-Notes-on-the-FSharpChecker-caches" class="anchor" href="#Compiler-Services-Notes-on-the-FSharpChecker-caches">Compiler Services: Notes on the FSharpChecker caches</a></h1>
 <p>This is a design note on the FSharpChecker component and its caches.  See also the notes on the <a href="queue.html">FSharpChecker operations queue</a></p>
 <p>Each FSharpChecker object maintains a set of caches.  These are</p>
 <ul>
 <li>
 <p><code>scriptClosureCache</code> - an MRU cache of default size <code>projectCacheSize</code> that caches the
-computation of GetProjectOptionsFromScript. This computation can be lengthy as it can involve processing the transative closure
+computation of GetProjectOptionsFromScript. This computation can be lengthy as it can involve processing the transitive closure
 of all <code>#load</code> directives, which in turn can mean parsing an unbounded number of script files</p>
 </li>
 <li>
@@ -83,7 +82,7 @@ <h1><a name="Compiler-Services-Notes-on-the-FSharpChecker-caches" class="anchor"
 the cache sizes above indicate the "strong" size of the cache, where memory is held regardless of the memory
 pressure on the system. Some of the caches can also hold "weak" references which can be collected at will by the GC.</p>
 <blockquote>
-<p>Note: Because of these caches, uou should generally use one global, shared FSharpChecker for everything in an IDE application.</p>
+<p>Note: Because of these caches, you should generally use one global, shared FSharpChecker for everything in an IDE application.</p>
 </blockquote>
 <h2><a name="Low-Memory-Condition" class="anchor" href="#Low-Memory-Condition">Low-Memory Condition</a></h2>
 <p>Version 1.4.0.8 added a "maximum memory" limit specified by the <code>MaxMemory</code> property on FSharpChecker (in MB). If an FCS project operation
@@ -117,10 +116,10 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
             <li><a href="./index.html">Home page</a></li>
             <li class="divider"></li>
             <li><a href="https://www.nuget.org/packages/FSharp.Compiler.Service">Get Library via NuGet</a></li>
-            <li><a href="http://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
-            <li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
-            <li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
-            
+            <li><a href="https://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
+            <li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
+            <li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
+
             <li class="nav-header">Getting started</li>
             <li><a href="./index.html">Home page</a></li>
             <li><a href="./devnotes.html">Developer notes</a></li>
@@ -149,6 +148,6 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
         </div>
       </div>
     </div>
-    <a href="http://github.com/fsharp/FSharp.Compiler.Service"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
+    <a href="https://github.com/fsharp/FSharp.Compiler.Service"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
   </body>
   </html>
diff --git a/docs/compiler.html b/docs/compiler.html
diff --git a/docs/content/style.css b/docs/content/style.css
@@ -12,14 +12,31 @@ span.pf { color:#E0C57F; }
 span.e { color:#EA8675; }
 
 /* identifiers --- and styles for more specific identifier types */
-span.i { color:#d1d1d1; }
-/* type or module */
-span.t { color:#43AEC6; }
+span.id { color:#d1d1d1; }
+/* module */
+span.m { color:#43AEC6; }
+/* reference type */
+span.rt { color:#43AEC6; }
+/* value type */
+span.vt { color:#43AEC6; }
+/* interface */
+span.if{ color:#43AEC6; }
+/* type argument */
+span.ta { color:#43AEC6; }
+/* disposable */
+span.d { color:#43AEC6; }
+/* property */
+span.prop { color:#43AEC6; }
+/* punctuation */
+span.p { color:#43AEC6; }
 /* function */
 span.f { color:#e1e1e1; }
-/* DU case or active pattern */
-span.p { color:#4ec9b0; }
-
+/* active pattern */
+span.pat { color:#4ec9b0; }
+/* union case */
+span.u { color:#4ec9b0; }
+/* enumeration */
+span.e { color:#4ec9b0; }
 /* keywords */
 span.k { color:#FAB11D; }
 /* comment */

diff --git a/docs/corelib.html b/docs/corelib.html
@@ -25,24 +25,23 @@
     <div class="container">
       <div class="masthead">
         <ul class="nav nav-pills pull-right">
-          <li><a href="http://fsharp.org">fsharp.org</a></li>
-          <li><a href="http://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
+          <li><a href="https://fsharp.org">fsharp.org</a></li>
+          <li><a href="https://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
         </ul>
         <h3 class="muted">F# Compiler Services</h3>
       </div>
       <hr />
       <div class="row">
         <div class="span9" id="main">
-
-<h1><a name="Compiler-Services-Notes-on-FSharp-Core-dll" class="anchor" href="#Compiler-Services-Notes-on-FSharp-Core-dll">Compiler Services: Notes on FSharp.Core.dll</a></h1>
+          <h1><a name="Compiler-Services-Notes-on-FSharp-Core-dll" class="anchor" href="#Compiler-Services-Notes-on-FSharp-Core-dll">Compiler Services: Notes on FSharp.Core.dll</a></h1>
 <h2><a name="Shipping-an-FSharp-Core-with-your-application" class="anchor" href="#Shipping-an-FSharp-Core-with-your-application">Shipping an FSharp.Core with your application</a></h2>
 <p>When building applications or plug-in components which use FSharp.Compiler.Service.dll, you will normally also
 include a copy of FSharp.Core.dll as part of your application.</p>
 <p>For example, if you build a <code>HostedCompiler.exe</code>, you will normally place an FSharp.Core.dll (say 4.3.1.0) alongside
 your <code>HostedCompiler.exe</code>.</p>
 <h2><a name="Binding-redirects-for-your-application" class="anchor" href="#Binding-redirects-for-your-application">Binding redirects for your application</a></h2>
 <p>The FSharp.Compiler.Service.dll component depends on FSharp.Core 4.4.0.0.  Normally your application will target
-a later version of FSharp.Core, and you may need a <a href="http://msdn.microsoft.com/en-us/library/7wd6ex19(v=vs.110).aspx">binding redirect</a> to ensure
+a later version of FSharp.Core, and you may need a <a href="https://docs.microsoft.com/en-us/dotnet/framework/configure-apps/redirect-assembly-versions">binding redirect</a> to ensure
 that other versions of FSharp.Core forward to the final version of FSharp.Core.dll your application uses.
 Binding redirect files are normally generated automatically by build tools. If not, you can use one like this
 (if your tool is called <code>HostedCompiler.exe</code>, the binding redirect file is called <code>HostedCompiler.exe.config</code>)</p>
@@ -63,21 +62,21 @@ <h2><a name="Binding-redirects-for-your-application" class="anchor" href="#Bindi
 <span class="l">14: </span>
 <span class="l">15: </span>
 </pre></td>
-<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="o">&lt;?</span><span class="i">xml</span> <span class="i">version</span><span class="o">=</span><span class="s">&quot;1.0&quot;</span> <span class="i">encoding</span><span class="o">=</span><span class="s">&quot;utf-8&quot;</span> <span class="o">?&gt;</span>
-<span class="o">&lt;</span><span class="i">configuration</span><span class="o">&gt;</span>
-    <span class="o">&lt;</span><span class="i">runtime</span><span class="o">&gt;</span>
-      <span class="o">&lt;</span><span class="i">assemblyBinding</span> <span class="i">xmlns</span><span class="o">=</span><span class="s">&quot;urn:schemas-microsoft-com:asm.v1&quot;</span><span class="o">&gt;</span>
-        <span class="o">&lt;</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
-          <span class="o">&lt;</span><span class="i">assemblyIdentity</span> <span class="i">name</span><span class="o">=</span><span class="s">&quot;FSharp.Core&quot;</span> <span class="i">publicKeyToken</span><span class="o">=</span><span class="s">&quot;b03f5f7f11d50a3a&quot;</span> <span class="i">culture</span><span class="o">=</span><span class="s">&quot;neutral&quot;</span><span class="o">/&gt;</span>
-          <span class="o">&lt;</span><span class="i">bindingRedirect</span> <span class="i">oldVersion</span><span class="o">=</span><span class="s">&quot;2.0.0.0-4.4.0.0&quot;</span> <span class="i">newVersion</span><span class="o">=</span><span class="s">&quot;4.4.1.0&quot;</span><span class="o">/&gt;</span>
-        <span class="o">&lt;/</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
-        <span class="o">&lt;</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
-          <span class="o">&lt;</span><span class="i">assemblyIdentity</span> <span class="i">name</span><span class="o">=</span><span class="s">&quot;System.Collections.Immutable&quot;</span> <span class="i">publicKeyToken</span><span class="o">=</span><span class="s">&quot;b03f5f7f11d50a3a&quot;</span> <span class="i">culture</span><span class="o">=</span><span class="s">&quot;neutral&quot;</span> <span class="o">/&gt;</span>
-          <span class="o">&lt;</span><span class="i">bindingRedirect</span> <span class="i">oldVersion</span><span class="o">=</span><span class="s">&quot;1.0.0.0-1.2.0.0&quot;</span> <span class="i">newVersion</span><span class="o">=</span><span class="s">&quot;1.2.1.0&quot;</span> <span class="o">/&gt;</span>
-        <span class="o">&lt;/</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
-      <span class="o">&lt;/</span><span class="i">assemblyBinding</span><span class="o">&gt;</span>
-    <span class="o">&lt;/</span><span class="i">runtime</span><span class="o">&gt;</span>	
-<span class="o">&lt;/</span><span class="i">configuration</span><span class="o">&gt;</span>
+<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="o">&lt;?</span><span class="id">xml</span> <span class="id">version</span><span class="o">=</span><span class="s">&quot;1.0&quot;</span> <span class="id">encoding</span><span class="o">=</span><span class="s">&quot;utf-8&quot;</span> <span class="o">?&gt;</span>
+<span class="pn">&lt;</span><span class="id">configuration</span><span class="pn">&gt;</span>
+    <span class="pn">&lt;</span><span class="id">runtime</span><span class="pn">&gt;</span>
+      <span class="pn">&lt;</span><span class="id">assemblyBinding</span> <span class="id">xmlns</span><span class="o">=</span><span class="s">&quot;urn:schemas-microsoft-com:asm.v1&quot;</span><span class="pn">&gt;</span>
+        <span class="pn">&lt;</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
+          <span class="pn">&lt;</span><span class="id">assemblyIdentity</span> <span class="id">name</span><span class="o">=</span><span class="s">&quot;FSharp.Core&quot;</span> <span class="id">publicKeyToken</span><span class="o">=</span><span class="s">&quot;b03f5f7f11d50a3a&quot;</span> <span class="id">culture</span><span class="o">=</span><span class="s">&quot;neutral&quot;</span><span class="o">/&gt;</span>
+          <span class="pn">&lt;</span><span class="id">bindingRedirect</span> <span class="id">oldVersion</span><span class="o">=</span><span class="s">&quot;2.0.0.0-4.4.0.0&quot;</span> <span class="id">newVersion</span><span class="o">=</span><span class="s">&quot;4.4.1.0&quot;</span><span class="o">/&gt;</span>
+        <span class="o">&lt;/</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
+        <span class="pn">&lt;</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
+          <span class="pn">&lt;</span><span class="id">assemblyIdentity</span> <span class="id">name</span><span class="o">=</span><span class="s">&quot;System.Collections.Immutable&quot;</span> <span class="id">publicKeyToken</span><span class="o">=</span><span class="s">&quot;b03f5f7f11d50a3a&quot;</span> <span class="id">culture</span><span class="o">=</span><span class="s">&quot;neutral&quot;</span> <span class="o">/&gt;</span>
+          <span class="pn">&lt;</span><span class="id">bindingRedirect</span> <span class="id">oldVersion</span><span class="o">=</span><span class="s">&quot;1.0.0.0-1.2.0.0&quot;</span> <span class="id">newVersion</span><span class="o">=</span><span class="s">&quot;1.2.1.0&quot;</span> <span class="o">/&gt;</span>
+        <span class="o">&lt;/</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
+      <span class="o">&lt;/</span><span class="id">assemblyBinding</span><span class="pn">&gt;</span>
+    <span class="o">&lt;/</span><span class="id">runtime</span><span class="pn">&gt;</span>
+<span class="o">&lt;/</span><span class="id">configuration</span><span class="pn">&gt;</span>
 </code></pre></td>
 </tr>
 </table>
@@ -98,21 +97,21 @@ <h2><a name="Which-FSharp-Core-and-NET-Framework-gets-referenced-in-compilation"
 <span class="l"> 9: </span>
 <span class="l">10: </span>
 </pre></td>
-<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp">[&lt;<span onmouseout="hideTip(event, 'fs1', 1)" onmouseover="showTip(event, 'fs1', 1)" class="i">Literal</span>&gt;]
-<span class="k">let</span> <span class="i">fsharpCorePath</span> <span class="o">=</span> 
+<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="pn">[&lt;</span><span onmouseout="hideTip(event, 'fs1', 1)" onmouseover="showTip(event, 'fs1', 1)" class="id">Literal</span><span class="pn">&gt;]</span>
+<span class="k">let</span> <span class="id">fsharpCorePath</span> <span class="o">=</span>
     <span class="s">@&quot;C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll&quot;</span>
-<span class="k">let</span> <span class="i">errors2</span>, <span class="i">exitCode2</span> <span class="o">=</span> 
-  <span class="i">scs</span><span class="o">.</span><span class="i">Compile</span>(
-    [| <span class="s">&quot;fsc.exe&quot;</span>; <span class="s">&quot;--noframework&quot;</span>; 
-       <span class="s">&quot;-r&quot;</span>; <span class="i">fsharpCorePath</span>; 
-       <span class="s">&quot;-r&quot;</span>; <span class="s">@&quot;C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll&quot;</span>; 
-       <span class="s">&quot;-o&quot;</span>; <span class="i">fn3</span>; 
-       <span class="s">&quot;-a&quot;</span>; <span class="i">fn2</span> |])
+<span class="k">let</span> <span class="id">errors2</span><span class="pn">,</span> <span class="id">exitCode2</span> <span class="o">=</span>
+  <span class="id">scs</span><span class="pn">.</span><span class="id">Compile</span><span class="pn">(</span>
+    <span class="pn">[|</span> <span class="s">&quot;fsc.exe&quot;</span><span class="pn">;</span> <span class="s">&quot;--noframework&quot;</span><span class="pn">;</span>
+       <span class="s">&quot;-r&quot;</span><span class="pn">;</span> <span class="id">fsharpCorePath</span><span class="pn">;</span>
+       <span class="s">&quot;-r&quot;</span><span class="pn">;</span> <span class="s">@&quot;C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll&quot;</span><span class="pn">;</span>
+       <span class="s">&quot;-o&quot;</span><span class="pn">;</span> <span class="id">fn3</span><span class="pn">;</span>
+       <span class="s">&quot;-a&quot;</span><span class="pn">;</span> <span class="id">fn2</span> <span class="pn">|]</span><span class="pn">)</span>
 </code></pre></td>
 </tr>
 </table>
 <p>You will need to determine the location of these assemblies.  The easiest way to locate these DLLs in a cross-platform way and
-convert them to command-line arguments is to <a href="http://fsharp.github.io/FSharp.Compiler.Service/project.html">crack an F# project file</a>.<br />
+convert them to command-line arguments is to <a href="https://fsharp.github.io/FSharp.Compiler.Service/project.html">crack an F# project file</a>.
 Alternatively you can compute SDK paths yourself, and some helpers to do this are in <a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/8a943dd3b545648690cb3bed652a469bdb6dd869/tests/service/Common.fs#L54">the tests for FSharp.Compiler.Service.dll</a>.</p>
 <h2><a name="What-about-if-I-am-processing-a-script-or-using" class="anchor" href="#What-about-if-I-am-processing-a-script-or-using">What about if I am processing a script or using <code>GetCheckOptionsFromScriptRoot</code></a></h2>
 <p>If you do <em>not</em> explicitly reference an FSharp.Core.dll from an SDK location, or if you are processing a script
@@ -137,7 +136,7 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
 <li>which FSharp.Core.dll and/or framework assemblies are  referenced during the checking and compilations performed by your tools.</li>
 </ul>
 
-<div class="tip" id="fs1">Multiple items<br />type LiteralAttribute =<br />&#160;&#160;inherit Attribute<br />&#160;&#160;new : unit -&gt; LiteralAttribute<br /><br />Full name: Microsoft.FSharp.Core.LiteralAttribute<br /><br />--------------------<br />new : unit -&gt; LiteralAttribute</div>
+<div class="tip" id="fs1">Multiple items<br />type LiteralAttribute =<br />&#160;&#160;inherit Attribute<br />&#160;&#160;new : unit -&gt; LiteralAttribute<br /><br />--------------------<br />new : unit -&gt; LiteralAttribute</div>
 
         </div>
         <div class="span3">
@@ -153,10 +152,10 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
             <li><a href="./index.html">Home page</a></li>
             <li class="divider"></li>
             <li><a href="https://www.nuget.org/packages/FSharp.Compiler.Service">Get Library via NuGet</a></li>
-            <li><a href="http://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
-            <li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
-            <li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
-            
+            <li><a href="https://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
+            <li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
+            <li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
+
             <li class="nav-header">Getting started</li>
             <li><a href="./index.html">Home page</a></li>
             <li><a href="./devnotes.html">Developer notes</a></li>
@@ -185,6 +184,6 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
         </div>
       </div>
     </div>
-    <a href="http://github.com/fsharp/FSharp.Compiler.Service"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
+    <a href="https://github.com/fsharp/FSharp.Compiler.Service"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
   </body>
   </html>