Skip to content

Commit ff4d182

Browse files
authored
Merge pull request #927 from nojaf/fix-docs
Fix docs generation for .net core
2 parents d12d208 + 4d4e42c commit ff4d182

File tree

590 files changed

+30200
-31599
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

590 files changed

+30200
-31599
lines changed

docs/caches.html

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,21 @@
2525
<div class="container">
2626
<div class="masthead">
2727
<ul class="nav nav-pills pull-right">
28-
<li><a href="http://fsharp.org">fsharp.org</a></li>
29-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
28+
<li><a href="https://fsharp.org">fsharp.org</a></li>
29+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
3030
</ul>
3131
<h3 class="muted">F# Compiler Services</h3>
3232
</div>
3333
<hr />
3434
<div class="row">
3535
<div class="span9" id="main">
36-
37-
<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>
36+
<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>
3837
<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>
3938
<p>Each FSharpChecker object maintains a set of caches. These are</p>
4039
<ul>
4140
<li>
4241
<p><code>scriptClosureCache</code> - an MRU cache of default size <code>projectCacheSize</code> that caches the
43-
computation of GetProjectOptionsFromScript. This computation can be lengthy as it can involve processing the transative closure
42+
computation of GetProjectOptionsFromScript. This computation can be lengthy as it can involve processing the transitive closure
4443
of all <code>#load</code> directives, which in turn can mean parsing an unbounded number of script files</p>
4544
</li>
4645
<li>
@@ -83,7 +82,7 @@ <h1><a name="Compiler-Services-Notes-on-the-FSharpChecker-caches" class="anchor"
8382
the cache sizes above indicate the "strong" size of the cache, where memory is held regardless of the memory
8483
pressure on the system. Some of the caches can also hold "weak" references which can be collected at will by the GC.</p>
8584
<blockquote>
86-
<p>Note: Because of these caches, uou should generally use one global, shared FSharpChecker for everything in an IDE application.</p>
85+
<p>Note: Because of these caches, you should generally use one global, shared FSharpChecker for everything in an IDE application.</p>
8786
</blockquote>
8887
<h2><a name="Low-Memory-Condition" class="anchor" href="#Low-Memory-Condition">Low-Memory Condition</a></h2>
8988
<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>
117116
<li><a href="./index.html">Home page</a></li>
118117
<li class="divider"></li>
119118
<li><a href="https://www.nuget.org/packages/FSharp.Compiler.Service">Get Library via NuGet</a></li>
120-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
121-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
122-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
123-
119+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
120+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
121+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
122+
124123
<li class="nav-header">Getting started</li>
125124
<li><a href="./index.html">Home page</a></li>
126125
<li><a href="./devnotes.html">Developer notes</a></li>
@@ -149,6 +148,6 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
149148
</div>
150149
</div>
151150
</div>
152-
<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>
151+
<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>
153152
</body>
154153
</html>

docs/compiler.html

Lines changed: 55 additions & 56 deletions
Large diffs are not rendered by default.

docs/content/style.css

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,31 @@ span.pf { color:#E0C57F; }
1212
span.e { color:#EA8675; }
1313

1414
/* identifiers --- and styles for more specific identifier types */
15-
span.i { color:#d1d1d1; }
16-
/* type or module */
17-
span.t { color:#43AEC6; }
15+
span.id { color:#d1d1d1; }
16+
/* module */
17+
span.m { color:#43AEC6; }
18+
/* reference type */
19+
span.rt { color:#43AEC6; }
20+
/* value type */
21+
span.vt { color:#43AEC6; }
22+
/* interface */
23+
span.if{ color:#43AEC6; }
24+
/* type argument */
25+
span.ta { color:#43AEC6; }
26+
/* disposable */
27+
span.d { color:#43AEC6; }
28+
/* property */
29+
span.prop { color:#43AEC6; }
30+
/* punctuation */
31+
span.p { color:#43AEC6; }
1832
/* function */
1933
span.f { color:#e1e1e1; }
20-
/* DU case or active pattern */
21-
span.p { color:#4ec9b0; }
22-
34+
/* active pattern */
35+
span.pat { color:#4ec9b0; }
36+
/* union case */
37+
span.u { color:#4ec9b0; }
38+
/* enumeration */
39+
span.e { color:#4ec9b0; }
2340
/* keywords */
2441
span.k { color:#FAB11D; }
2542
/* comment */

docs/corelib.html

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,23 @@
2525
<div class="container">
2626
<div class="masthead">
2727
<ul class="nav nav-pills pull-right">
28-
<li><a href="http://fsharp.org">fsharp.org</a></li>
29-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
28+
<li><a href="https://fsharp.org">fsharp.org</a></li>
29+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service">github page</a></li>
3030
</ul>
3131
<h3 class="muted">F# Compiler Services</h3>
3232
</div>
3333
<hr />
3434
<div class="row">
3535
<div class="span9" id="main">
36-
37-
<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>
36+
<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>
3837
<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>
3938
<p>When building applications or plug-in components which use FSharp.Compiler.Service.dll, you will normally also
4039
include a copy of FSharp.Core.dll as part of your application.</p>
4140
<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
4241
your <code>HostedCompiler.exe</code>.</p>
4342
<h2><a name="Binding-redirects-for-your-application" class="anchor" href="#Binding-redirects-for-your-application">Binding redirects for your application</a></h2>
4443
<p>The FSharp.Compiler.Service.dll component depends on FSharp.Core 4.4.0.0. Normally your application will target
45-
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
44+
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
4645
that other versions of FSharp.Core forward to the final version of FSharp.Core.dll your application uses.
4746
Binding redirect files are normally generated automatically by build tools. If not, you can use one like this
4847
(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
6362
<span class="l">14: </span>
6463
<span class="l">15: </span>
6564
</pre></td>
66-
<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>
67-
<span class="o">&lt;</span><span class="i">configuration</span><span class="o">&gt;</span>
68-
<span class="o">&lt;</span><span class="i">runtime</span><span class="o">&gt;</span>
69-
<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>
70-
<span class="o">&lt;</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
71-
<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>
72-
<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>
73-
<span class="o">&lt;/</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
74-
<span class="o">&lt;</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
75-
<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>
76-
<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>
77-
<span class="o">&lt;/</span><span class="i">dependentAssembly</span><span class="o">&gt;</span>
78-
<span class="o">&lt;/</span><span class="i">assemblyBinding</span><span class="o">&gt;</span>
79-
<span class="o">&lt;/</span><span class="i">runtime</span><span class="o">&gt;</span>
80-
<span class="o">&lt;/</span><span class="i">configuration</span><span class="o">&gt;</span>
65+
<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>
66+
<span class="pn">&lt;</span><span class="id">configuration</span><span class="pn">&gt;</span>
67+
<span class="pn">&lt;</span><span class="id">runtime</span><span class="pn">&gt;</span>
68+
<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>
69+
<span class="pn">&lt;</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
70+
<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>
71+
<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>
72+
<span class="o">&lt;/</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
73+
<span class="pn">&lt;</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
74+
<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>
75+
<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>
76+
<span class="o">&lt;/</span><span class="id">dependentAssembly</span><span class="pn">&gt;</span>
77+
<span class="o">&lt;/</span><span class="id">assemblyBinding</span><span class="pn">&gt;</span>
78+
<span class="o">&lt;/</span><span class="id">runtime</span><span class="pn">&gt;</span>
79+
<span class="o">&lt;/</span><span class="id">configuration</span><span class="pn">&gt;</span>
8180
</code></pre></td>
8281
</tr>
8382
</table>
@@ -98,21 +97,21 @@ <h2><a name="Which-FSharp-Core-and-NET-Framework-gets-referenced-in-compilation"
9897
<span class="l"> 9: </span>
9998
<span class="l">10: </span>
10099
</pre></td>
101-
<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;]
102-
<span class="k">let</span> <span class="i">fsharpCorePath</span> <span class="o">=</span>
100+
<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>
101+
<span class="k">let</span> <span class="id">fsharpCorePath</span> <span class="o">=</span>
103102
<span class="s">@&quot;C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll&quot;</span>
104-
<span class="k">let</span> <span class="i">errors2</span>, <span class="i">exitCode2</span> <span class="o">=</span>
105-
<span class="i">scs</span><span class="o">.</span><span class="i">Compile</span>(
106-
[| <span class="s">&quot;fsc.exe&quot;</span>; <span class="s">&quot;--noframework&quot;</span>;
107-
<span class="s">&quot;-r&quot;</span>; <span class="i">fsharpCorePath</span>;
108-
<span class="s">&quot;-r&quot;</span>; <span class="s">@&quot;C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll&quot;</span>;
109-
<span class="s">&quot;-o&quot;</span>; <span class="i">fn3</span>;
110-
<span class="s">&quot;-a&quot;</span>; <span class="i">fn2</span> |])
103+
<span class="k">let</span> <span class="id">errors2</span><span class="pn">,</span> <span class="id">exitCode2</span> <span class="o">=</span>
104+
<span class="id">scs</span><span class="pn">.</span><span class="id">Compile</span><span class="pn">(</span>
105+
<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>
106+
<span class="s">&quot;-r&quot;</span><span class="pn">;</span> <span class="id">fsharpCorePath</span><span class="pn">;</span>
107+
<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>
108+
<span class="s">&quot;-o&quot;</span><span class="pn">;</span> <span class="id">fn3</span><span class="pn">;</span>
109+
<span class="s">&quot;-a&quot;</span><span class="pn">;</span> <span class="id">fn2</span> <span class="pn">|]</span><span class="pn">)</span>
111110
</code></pre></td>
112111
</tr>
113112
</table>
114113
<p>You will need to determine the location of these assemblies. The easiest way to locate these DLLs in a cross-platform way and
115-
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 />
114+
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>.
116115
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>
117116
<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>
118117
<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>
137136
<li>which FSharp.Core.dll and/or framework assemblies are referenced during the checking and compilations performed by your tools.</li>
138137
</ul>
139138

140-
<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>
139+
<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>
141140

142141
</div>
143142
<div class="span3">
@@ -153,10 +152,10 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
153152
<li><a href="./index.html">Home page</a></li>
154153
<li class="divider"></li>
155154
<li><a href="https://www.nuget.org/packages/FSharp.Compiler.Service">Get Library via NuGet</a></li>
156-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
157-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
158-
<li><a href="http://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
159-
155+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service">Source Code on GitHub</a></li>
156+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/LICENSE">License</a></li>
157+
<li><a href="https://github.com/fsharp/FSharp.Compiler.Service/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
158+
160159
<li class="nav-header">Getting started</li>
161160
<li><a href="./index.html">Home page</a></li>
162161
<li><a href="./devnotes.html">Developer notes</a></li>
@@ -185,6 +184,6 @@ <h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
185184
</div>
186185
</div>
187186
</div>
188-
<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>
187+
<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>
189188
</body>
190189
</html>

0 commit comments

Comments
 (0)