Skip to content

Commit 84655d9

Browse files
dsymedsyme
authored
Merge pull request #794 from dsyme/docs1
Update docs
2 parents 8a3c086 + b32e67a commit 84655d9

File tree

441 files changed

+11120
-11486
lines changed

Some content is hidden

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

441 files changed

+11120
-11486
lines changed

‎docs/interactive.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ <h2><a name="Type-checking-in-the-evaluation-context" class="anchor" href="#Type
340340
</table>
341341
<h2><a name="The-fsi-object" class="anchor" href="#The-fsi-object">The 'fsi' object</a></h2>
342342
<p>If you want your scripting code to be able to access the 'fsi' object, you should pass in an implementation of this object explicitly.
343-
Normally, the one from <code>FSharp.Compiler.Interactive.Settings.dll</code> is used.</p>
343+
Normally the one fromm FSharp.Compiler.Interactive.Settings.dll is used.</p>
344344
<table class="pre"><tr><td class="lines"><pre class="fssnip"><span class="l">1: </span>
345345
</pre></td>
346346
<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span class="i">fsiConfig2</span> <span class="o">=</span> <span class="i">FsiEvaluationSession</span><span class="o">.</span><span class="i">GetDefaultConfiguration</span>(<span class="i">fsi</span>)

‎docs/reference/index.html‎

Lines changed: 97 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -149,26 +149,7 @@ <h2>Internal.Utilities.StructuredFormat Namespace</h2>
149149
</div>
150150
<h2>Microsoft.FSharp.Compiler Namespace</h2>
151151
<div>
152-
<table class="table table-bordered type-list">
153-
<thead>
154-
<tr><td>Type</td><td>Description</td></tr>
155-
</thead>
156-
<tbody>
157-
<tr>
158-
<td class="type-name">
159-
<a href="microsoft-fsharp-compiler-fsharperrorinfo.html">FSharpErrorInfo</a>
160-
</td>
161-
<td class="xmldoc"></td>
162-
</tr>
163-
<tr>
164-
<td class="type-name">
165-
<a href="microsoft-fsharp-compiler-fsharperrorseverity.html">FSharpErrorSeverity</a>
166-
</td>
167-
<td class="xmldoc"></td>
168-
</tr>
169-
</tbody>
170-
</table>
171-
<table class="table table-bordered module-list">
152+
<table class="table table-bordered module-list">
172153
<thead>
173154
<tr><td>Module</td><td>Description</td></tr>
174155
</thead>
@@ -205,6 +186,12 @@ <h2>Microsoft.FSharp.Compiler Namespace</h2>
205186
</td>
206187
<td class="xmldoc"></td>
207188
</tr>
189+
<tr>
190+
<td class="module-name">
191+
<a href="microsoft-fsharp-compiler-referenceresolver.html">ReferenceResolver</a>
192+
</td>
193+
<td class="xmldoc"></td>
194+
</tr>
208195
</tbody>
209196
</table>
210197

@@ -262,25 +249,6 @@ <h2>Microsoft.FSharp.Compiler.Interactive Namespace</h2>
262249
</tbody>
263250
</table>
264251

265-
</div>
266-
<h2>Microsoft.FSharp.Compiler.SimpleSourceCodeServices Namespace</h2>
267-
<div>
268-
<table class="table table-bordered type-list">
269-
<thead>
270-
<tr><td>Type</td><td>Description</td></tr>
271-
</thead>
272-
<tbody>
273-
<tr>
274-
<td class="type-name">
275-
<a href="microsoft-fsharp-compiler-simplesourcecodeservices-simplesourcecodeservices.html">SimpleSourceCodeServices</a>
276-
</td>
277-
<td class="xmldoc"><p>Provides simpler version of services for checking and compiling F# scripts</p>
278-
279-
</td>
280-
</tr>
281-
</tbody>
282-
</table>
283-
284252
</div>
285253
<h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
286254
<div>
@@ -361,6 +329,22 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
361329
</td>
362330
<td class="xmldoc"></td>
363331
</tr>
332+
<tr>
333+
<td class="type-name">
334+
<a href="microsoft-fsharp-compiler-sourcecodeservices-externalsymbol.html">ExternalSymbol</a>
335+
</td>
336+
<td class="xmldoc"><p>Represents a symbol in an external (non F#) assembly</p>
337+
338+
</td>
339+
</tr>
340+
<tr>
341+
<td class="type-name">
342+
<a href="microsoft-fsharp-compiler-sourcecodeservices-externaltype.html">ExternalType</a>
343+
</td>
344+
<td class="xmldoc"><p>Represents a type in an external (non F#) assembly.</p>
345+
346+
</td>
347+
</tr>
364348
<tr>
365349
<td class="type-name">
366350
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html">FSharpAbstractParameter</a>
@@ -524,6 +508,18 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
524508

525509
</td>
526510
</tr>
511+
<tr>
512+
<td class="type-name">
513+
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharperrorinfo.html">FSharpErrorInfo</a>
514+
</td>
515+
<td class="xmldoc"></td>
516+
</tr>
517+
<tr>
518+
<td class="type-name">
519+
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharperrorseverity.html">FSharpErrorSeverity</a>
520+
</td>
521+
<td class="xmldoc"></td>
522+
</tr>
527523
<tr>
528524
<td class="type-name">
529525
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharpexpr.html">FSharpExpr</a>
@@ -638,14 +634,6 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
638634
<p>A new lexState is also returned. An IDE-plugin should in general cache the lexState
639635
values for each line of the edited code.</p>
640636

641-
</td>
642-
</tr>
643-
<tr>
644-
<td class="type-name">
645-
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharpmemberfunctionorvalue.html">FSharpMemberFunctionOrValue</a>
646-
</td>
647-
<td class="xmldoc"><p>Renamed to FSharpMemberOrFunctionOrValue</p>
648-
649637
</td>
650638
</tr>
651639
<tr>
@@ -654,14 +642,6 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
654642
</td>
655643
<td class="xmldoc"><p>A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members.</p>
656644

657-
</td>
658-
</tr>
659-
<tr>
660-
<td class="type-name">
661-
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharpmemberorval.html">FSharpMemberOrVal</a>
662-
</td>
663-
<td class="xmldoc"><p>Renamed to FSharpMemberOrFunctionOrValue</p>
664-
665645
</td>
666646
</tr>
667647
<tr>
@@ -768,14 +748,6 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
768748
</td>
769749
<td class="xmldoc"><p>A set of information describing a project or script build configuration.</p>
770750

771-
</td>
772-
</tr>
773-
<tr>
774-
<td class="type-name">
775-
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharprecordfield.html">FSharpRecordField</a>
776-
</td>
777-
<td class="xmldoc"><p>Renamed to FSharpField</p>
778-
779751
</td>
780752
</tr>
781753
<tr>
@@ -889,6 +861,14 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
889861
</td>
890862
<td class="xmldoc"><p>A single data tip display element with where text is expressed as string</p>
891863

864+
</td>
865+
</tr>
866+
<tr>
867+
<td class="type-name">
868+
<a href="microsoft-fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html">FSharpToolTipElementData<'T></a>
869+
</td>
870+
<td class="xmldoc"><p>A single data tip display element</p>
871+
892872
</td>
893873
</tr>
894874
<tr>
@@ -993,6 +973,22 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
993973
</td>
994974
<td class="xmldoc"></td>
995975
</tr>
976+
<tr>
977+
<td class="type-name">
978+
<a href="microsoft-fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html">OpenStatementInsertionPoint</a>
979+
</td>
980+
<td class="xmldoc"><p>Where open statements should be added.</p>
981+
982+
</td>
983+
</tr>
984+
<tr>
985+
<td class="type-name">
986+
<a href="microsoft-fsharp-compiler-sourcecodeservices-paramtypesymbol.html">ParamTypeSymbol</a>
987+
</td>
988+
<td class="xmldoc"><p>Represents the type of a single method parameter</p>
989+
990+
</td>
991+
</tr>
996992
<tr>
997993
<td class="type-name">
998994
<a href="microsoft-fsharp-compiler-sourcecodeservices-position.html">Position</a>
@@ -1051,9 +1047,11 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
10511047
</tr>
10521048
<tr>
10531049
<td class="type-name">
1054-
<a href="microsoft-fsharp-compiler-sourcecodeservices-unresolvedsymbol.html">UnresolvedSymbol</a>
1050+
<a href="microsoft-fsharp-compiler-sourcecodeservices-xmldocable.html">XmlDocable</a>
10551051
</td>
1056-
<td class="xmldoc"></td>
1052+
<td class="xmldoc"><p>Represent an Xml documentation block in source code</p>
1053+
1054+
</td>
10571055
</tr>
10581056
</tbody>
10591057
</table>
@@ -1104,13 +1102,13 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
11041102
</tr>
11051103
<tr>
11061104
<td class="module-name">
1107-
<a href="microsoft-fsharp-compiler-sourcecodeservices-envmisc2.html">EnvMisc2</a>
1105+
<a href="microsoft-fsharp-compiler-sourcecodeservices-extensions.html">Extensions</a>
11081106
</td>
11091107
<td class="xmldoc"></td>
11101108
</tr>
11111109
<tr>
11121110
<td class="module-name">
1113-
<a href="microsoft-fsharp-compiler-sourcecodeservices-extensions.html">Extensions</a>
1111+
<a href="microsoft-fsharp-compiler-sourcecodeservices-externaltypemodule.html">ExternalType</a>
11141112
</td>
11151113
<td class="xmldoc"></td>
11161114
</tr>
@@ -1134,6 +1132,12 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
11341132
</td>
11351133
<td class="xmldoc"></td>
11361134
</tr>
1135+
<tr>
1136+
<td class="module-name">
1137+
<a href="microsoft-fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html">ParamTypeSymbol</a>
1138+
</td>
1139+
<td class="xmldoc"></td>
1140+
</tr>
11371141
<tr>
11381142
<td class="module-name">
11391143
<a href="microsoft-fsharp-compiler-sourcecodeservices-parsedinput.html">ParsedInput</a>
@@ -1150,12 +1154,38 @@ <h2>Microsoft.FSharp.Compiler.SourceCodeServices Namespace</h2>
11501154

11511155
</td>
11521156
</tr>
1157+
<tr>
1158+
<td class="module-name">
1159+
<a href="microsoft-fsharp-compiler-sourcecodeservices-sourcefile.html">SourceFile</a>
1160+
</td>
1161+
<td class="xmldoc"><p>Information about F# source file names</p>
1162+
1163+
</td>
1164+
</tr>
1165+
<tr>
1166+
<td class="module-name">
1167+
<a href="microsoft-fsharp-compiler-sourcecodeservices-tooltips.html">Tooltips</a>
1168+
</td>
1169+
<td class="xmldoc"></td>
1170+
</tr>
11531171
<tr>
11541172
<td class="module-name">
11551173
<a href="microsoft-fsharp-compiler-sourcecodeservices-untypedparseimpl.html">UntypedParseImpl</a>
11561174
</td>
11571175
<td class="xmldoc"></td>
11581176
</tr>
1177+
<tr>
1178+
<td class="module-name">
1179+
<a href="microsoft-fsharp-compiler-sourcecodeservices-xmldoccomment.html">XmlDocComment</a>
1180+
</td>
1181+
<td class="xmldoc"></td>
1182+
</tr>
1183+
<tr>
1184+
<td class="module-name">
1185+
<a href="microsoft-fsharp-compiler-sourcecodeservices-xmldocparser.html">XmlDocParser</a>
1186+
</td>
1187+
<td class="xmldoc"></td>
1188+
</tr>
11591189
</tbody>
11601190
</table>
11611191

‎docs/reference/internal-utilities-structuredformat-display.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h3>Functions and values</h3>
6262
<strong>Type parameters:</strong> 'T </div>
6363
</td>
6464
<td class="xmldoc">
65-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1359-1359" class="github-link">
65+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1281-1281" class="github-link">
6666
<img src="../content/img/github.png" class="normal" />
6767
<img src="../content/img/github-blue.png" class="hover" />
6868
</a>
@@ -80,7 +80,7 @@ <h3>Functions and values</h3>
8080
<strong>Type parameters:</strong> 'T </div>
8181
</td>
8282
<td class="xmldoc">
83-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1390-1390" class="github-link">
83+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1312-1312" class="github-link">
8484
<img src="../content/img/github.png" class="normal" />
8585
<img src="../content/img/github-blue.png" class="hover" />
8686
</a>
@@ -110,7 +110,7 @@ <h3>Functions and values</h3>
110110
</div>
111111
</td>
112112
<td class="xmldoc">
113-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1368-1368" class="github-link">
113+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1290-1290" class="github-link">
114114
<img src="../content/img/github.png" class="normal" />
115115
<img src="../content/img/github-blue.png" class="hover" />
116116
</a>
@@ -128,7 +128,7 @@ <h3>Functions and values</h3>
128128
<strong>Type parameters:</strong> 'T </div>
129129
</td>
130130
<td class="xmldoc">
131-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1404-1404" class="github-link">
131+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1316-1316" class="github-link">
132132
<img src="../content/img/github.png" class="normal" />
133133
<img src="../content/img/github-blue.png" class="hover" />
134134
</a>
@@ -146,7 +146,7 @@ <h3>Functions and values</h3>
146146
<strong>Type parameters:</strong> 'T </div>
147147
</td>
148148
<td class="xmldoc">
149-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1388-1388" class="github-link">
149+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1310-1310" class="github-link">
150150
<img src="../content/img/github.png" class="normal" />
151151
<img src="../content/img/github-blue.png" class="hover" />
152152
</a>
@@ -164,7 +164,7 @@ <h3>Functions and values</h3>
164164
</div>
165165
</td>
166166
<td class="xmldoc">
167-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1380-1380" class="github-link">
167+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1302-1302" class="github-link">
168168
<img src="../content/img/github.png" class="normal" />
169169
<img src="../content/img/github-blue.png" class="hover" />
170170
</a>
@@ -187,7 +187,7 @@ <h3>Functions and values</h3>
187187
<strong>Type parameters:</strong> 'T </div>
188188
</td>
189189
<td class="xmldoc">
190-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1386-1386" class="github-link">
190+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1308-1308" class="github-link">
191191
<img src="../content/img/github.png" class="normal" />
192192
<img src="../content/img/github-blue.png" class="hover" />
193193
</a>
@@ -208,7 +208,7 @@ <h3>Functions and values</h3>
208208
</div>
209209
</td>
210210
<td class="xmldoc">
211-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1377-1377" class="github-link">
211+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1299-1299" class="github-link">
212212
<img src="../content/img/github.png" class="normal" />
213213
<img src="../content/img/github-blue.png" class="hover" />
214214
</a>
@@ -226,7 +226,7 @@ <h3>Functions and values</h3>
226226
</div>
227227
</td>
228228
<td class="xmldoc">
229-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1373-1373" class="github-link">
229+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1295-1295" class="github-link">
230230
<img src="../content/img/github.png" class="normal" />
231231
<img src="../content/img/github-blue.png" class="hover" />
232232
</a>
@@ -244,7 +244,7 @@ <h3>Functions and values</h3>
244244
</div>
245245
</td>
246246
<td class="xmldoc">
247-
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1361-1361" class="github-link">
247+
<a href="https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src/utils/sformat.fs#L1283-1283" class="github-link">
248248
<img src="../content/img/github.png" class="normal" />
249249
<img src="../content/img/github-blue.png" class="hover" />
250250
</a>

0 commit comments

Comments
 (0)