Skip to content

Commit fd52d6a

Browse files
gewarrengewarren
authored
Fix up tables (2 of 2) (#4330)
* fix up tables
1 parent 1c2f680 commit fd52d6a

File tree

29 files changed

+238
-396
lines changed

29 files changed

+238
-396
lines changed

‎xml/Microsoft.Extensions.FileSystemGlobbing/Matcher.xml

Lines changed: 62 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -22,71 +22,98 @@
2222
<Docs>
2323
<summary>Searches the file system for files with names that match specified patterns.</summary>
2424
<remarks>
25-
<para>Patterns specified in <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" /> and <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" /> can use
26-
the following formats to match multiple files or directories.</para>
25+
<para>Patterns specified in <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" /> and <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" /> can use the following formats to match multiple files or directories.</para>
2726
<list type="bullet">
2827
<item>
29-
<term>
30-
exact directory and file name
31-
</term>
32-
<description>
28+
<description>Exact directory and file name.
3329
<list type="bullet">
3430
<item>
35-
<term>"one.txt"</term>
31+
<description><c>one.txt</c></description>
3632
</item>
3733
<item>
38-
<term>"dir/two.txt"</term>
34+
<description><c>dir/two.txt</c></description>
3935
</item>
4036
</list>
4137
</description>
4238
</item>
4339
<item>
44-
<term>
45-
wildcards (*) in file and directory names that represent zero to many characters not including
46-
directory separators characters
47-
</term>
48-
<description>
49-
<list type="bullet">
40+
<description>Wildcards (*) in file and directory names that represent zero to many characters not including directory separators characters.
41+
<list type="table">
42+
<listheader>
43+
<term>Value</term>
44+
<description>Description</description>
45+
</listheader>
46+
<item>
47+
<term><c>*.txt</c></term>
48+
<description>All files with .txt file extension.</description>
49+
</item>
50+
<item>
51+
<term><c>*.*</c></term>
52+
<description>All files with an extension.</description>
53+
</item>
54+
<item>
55+
<term><c>*</c></term>
56+
<description>All files in top-level directory.</description>
57+
</item>
58+
<item>
59+
<term><c>.*</c></term>
60+
<description>File names beginning with '.'.</description>
61+
</item>
5062
<item>
51-
<term>"*.txt"</term>
52-
<description>all files with .txt file extension</description>
63+
<term><c>*word*</c></term>
64+
<description>All files with 'word' in the filename.</description>
5365
</item>
5466
<item>
55-
<term>"*.*"</term>
56-
<description>all files with an extension</description>
67+
<term><c>readme.*</c></term>
68+
<description>All files named 'readme' with any file extension.</description>
5769
</item>
5870
<item>
59-
<term>"*"</term>
60-
<description>all files in top level directory</description>
71+
<term><c>styles/*.css</c></term>
72+
<description>All files with extension '.css' in the directory 'styles/'.</description>
6173
</item>
6274
<item>
63-
<term>".*"</term>
64-
<description>filenames beginning with '.'</description>
75+
<term><c>scripts/*/*</c></term>
76+
<description>All files in 'scripts/' or one level of subdirectory under 'scripts/'.</description>
6577
</item>
66-
- "*word* - all files with 'word' in the filename
67-
<item><term>"readme.*"</term><description>all files named 'readme' with any file extension</description></item><item><term>"styles/*.css"</term><description>all files with extension '.css' in the directory 'styles/'</description></item><item><term>"scripts/*/*"</term><description>all files in 'scripts/' or one level of subdirectory under 'scripts/'</description></item><item><term>"images*/*"</term><description>all files in a folder with name that is or begins with 'images'</description></item></list>
78+
<item>
79+
<term><c>images*/*</c></term>
80+
<description>All files in a folder with name that is or begins with 'images'.</description>
81+
</item>
82+
</list>
6883
</description>
6984
</item>
7085
<item>
71-
<term>arbitrary directory depth ("/**/")</term>
72-
<description>
73-
<list type="bullet">
86+
<description>Arbitrary directory depth (<c>/**/</c>).
87+
<list type="table">
88+
<listheader>
89+
<term>Value</term>
90+
<description>Description</description>
91+
</listheader>
7492
<item>
75-
<term>"**/*"</term>
76-
<description>all files in any subdirectory</description>
93+
<term><c>**/*</c></term>
94+
<description>All files in any subdirectory.</description>
7795
</item>
7896
<item>
79-
<term>"dir/**/*"</term>
80-
<description>all files in any subdirectory under 'dir/'</description>
97+
<term><c>dir/**/*</c></term>
98+
<description>All files in any subdirectory under 'dir/'.</description>
8199
</item>
82100
</list>
83101
</description>
84102
</item>
85103
<item>
86-
<term>relative paths</term>
87-
<description>
88-
'../shared/*' - all files in a diretory named 'shared' at the sibling level to the base directory given
89-
to <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /></description>
104+
<description>Relative paths.
105+
<list type="table">
106+
<listheader>
107+
<term>Value</term>
108+
<description>Description</description>
109+
</listheader>
110+
<item>
111+
<term><c>../shared/*</c></term>
112+
<description>All files in a diretory named "shared" at the sibling level to the base directory given to <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" />.
113+
</description>
114+
</item>
115+
</list>
116+
</description>
90117
</item>
91118
</list>
92119
</remarks>

‎xml/Microsoft.Extensions.FileSystemGlobbing/MatcherExtensions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<Docs>
5959
<param name="matcher">The matcher to which the exclude patterns are added</param>
6060
<param name="excludePatternsGroups">A list of globbing patterns</param>
61-
<summary>Adds multiple exclude patterns to <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" /></summary>
61+
<summary>Adds multiple exclude patterns to <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. Also see <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" />.</summary>
6262
<remarks>To be added.</remarks>
6363
</Docs>
6464
</Member>
@@ -96,7 +96,7 @@
9696
<Docs>
9797
<param name="matcher">The matcher to which the include patterns are added</param>
9898
<param name="includePatternsGroups">A list of globbing patterns</param>
99-
<summary>Adds multiple patterns to include in <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. See <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" /></summary>
99+
<summary>Adds multiple patterns to include in <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. Also see <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" />.</summary>
100100
<remarks>To be added.</remarks>
101101
</Docs>
102102
</Member>

‎xml/Microsoft.VisualBasic.CompilerServices/ObjectType.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,7 @@
687687
</description>
688688
</item>
689689
</list>
690-
.</returns>
690+
</returns>
691691
<remarks>
692692
<format type="text/markdown"><![CDATA[
693693

‎xml/Microsoft.VisualBasic.CompilerServices/Operators.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@
194194
</description>
195195
</item>
196196
</list>
197-
.</returns>
197+
</returns>
198198
<remarks>
199199
<format type="text/markdown"><![CDATA[
200200
@@ -560,7 +560,7 @@
560560
</description>
561561
</item>
562562
</list>
563-
.</returns>
563+
</returns>
564564
<remarks>
565565
<format type="text/markdown"><![CDATA[
566566

‎xml/Microsoft.VisualBasic.CompilerServices/StringType.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,7 @@
838838
</description>
839839
</item>
840840
</list>
841-
.</returns>
841+
</returns>
842842
<remarks>
843843
<format type="text/markdown"><![CDATA[
844844

‎xml/Microsoft.VisualBasic/FileSystem.xml

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -582,30 +582,25 @@
582582
<Docs>
583583
<param name="FileNumber">Required. <see langword="Integer" />. Any valid file number.</param>
584584
<summary>Returns an enumeration representing the file mode for files opened using the <see langword="FileOpen" /> function. The <see cref="T:Microsoft.VisualBasic.FileIO.FileSystem" /> gives you better productivity and performance in file I/O operations than the <see langword="FileAttr" /> function. See <see cref="M:Microsoft.VisualBasic.FileIO.FileSystem.GetFileInfo(System.String)" /> for more information.</summary>
585-
<returns>The following enumeration values indicate the file access mode:
586-
587-
<list type="table"><item><term> Value
588-
589-
</term><description> Mode
590-
591-
</description></item><item><term> 1
592-
593-
</term><description><see langword="OpenMode.Input" /></description></item><item><term> 2
594-
595-
</term><description><see langword="OpenMode.Output" /></description></item><item><term> 4
596-
597-
</term><description><see langword="OpenMode.Random" /></description></item><item><term> 8
598-
599-
</term><description><see langword="OpenMode.Append" /></description></item><item><term> 32
600-
601-
</term><description><see langword="OpenMode.Binary" /></description></item></list></returns>
585+
<returns>One of the following values:
586+
587+
<list type="table">
588+
<listheader>
589+
<term>Value</term>
590+
<description>File access mode</description>
591+
</listheader>
592+
<item><term>1</term><description><see langword="OpenMode.Input" /></description></item>
593+
<item><term>2</term><description><see langword="OpenMode.Output" /></description></item>
594+
<item><term>4</term><description><see langword="OpenMode.Random" /></description></item>
595+
<item><term>8</term><description><see langword="OpenMode.Append" /></description></item>
596+
<item><term>32</term><description><see langword="OpenMode.Binary" /></description></item>
597+
</list>
598+
</returns>
602599
<remarks>
603600
<format type="text/markdown"><![CDATA[
604601

605602
## Remarks
606-
This function returns an enumeration representing the file mode for files opened using the `FileOpen` function.
607-
608-
603+
This function returns an enumeration representing the file mode for files opened using the `FileOpen` function.
609604

610605
## Examples
611606
This example uses the `FileAttr` function to return the file mode of an open file.

0 commit comments

Comments
 (0)