Skip to content

Commit 7d83aff

Browse files
mdaiglemdaigle
committed
Fix nesting and generate docs.
1 parent 7ff7a16 commit 7d83aff

5 files changed

Lines changed: 22 additions & 21 deletions

File tree

‎src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<Configurations>Debug;Release;</Configurations>
66
<RootNamespace />
77
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
8+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
89
</PropertyGroup>
910

1011
<!-- CLS Compliance ================================================== -->

‎src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDataReader.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2598,15 +2598,15 @@ virtual public SqlXml GetSqlXml(int i)
25982598
return sx;
25992599
}
26002600

2601-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml' path='docs/members[@name="SqlDataReader"]/GetSqlJson/*' />
2601+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml' path='docs/members[@name="SqlDataReader"]/GetSqlJson/*' />
26022602
virtual public SqlJson GetSqlJson(int i)
26032603
{
26042604
ReadColumn(i);
26052605
SqlJson json = _data[i].IsNull ? SqlJson.Null : _data[i].SqlJson;
26062606
return json;
26072607
}
26082608

2609-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml' path='docs/members[@name="SqlDataReader"]/GetSqlVector/*' />
2609+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml' path='docs/members[@name="SqlDataReader"]/GetSqlVector/*' />
26102610
virtual public SqlVector<T> GetSqlVector<T>(int i) where T : unmanaged
26112611
{
26122612
if (typeof(T) != typeof(float))

‎src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlDbTypeExtensions.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
namespace Microsoft.Data
88
{
9-
/// <include file='../../../../doc/snippets/Microsoft.Data/SqlDbTypeExtensions.xml' path='docs/members[@name="SqlDbTypeExtensions"]/SqlDbTypeExtensions/*' />
9+
/// <include file='../../../../../doc/snippets/Microsoft.Data/SqlDbTypeExtensions.xml' path='docs/members[@name="SqlDbTypeExtensions"]/SqlDbTypeExtensions/*' />
1010
public static class SqlDbTypeExtensions
1111
{
12-
/// <include file='../../../../doc/snippets/Microsoft.Data/SqlDbTypeExtensions.xml' path='docs/members[@name="SqlDbTypeExtensions"]/SqlJson[@name="default"]' />
12+
/// <include file='../../../../../doc/snippets/Microsoft.Data/SqlDbTypeExtensions.xml' path='docs/members[@name="SqlDbTypeExtensions"]/SqlJson[@name="default"]' />
1313
#if NET9_0_OR_GREATER
1414
public const SqlDbType Json = SqlDbType.Json;
1515
#else
1616
public const SqlDbType Json = (SqlDbType)35;
1717
#endif
18-
/// <include file='../../../../doc/snippets/Microsoft.Data/SqlDbTypeExtensions.xml' path='docs/members[@name="SqlDbTypeExtensions"]/SqlVector[@name="default"]' />
18+
/// <include file='../../../../../doc/snippets/Microsoft.Data/SqlDbTypeExtensions.xml' path='docs/members[@name="SqlDbTypeExtensions"]/SqlVector[@name="default"]' />
1919
#if NET10_0_OR_GREATER
2020
public const SqlDbType Vector = SqlDbType.Vector;
2121
#else

‎src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlJson.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@
1212

1313
namespace Microsoft.Data.SqlTypes
1414
{
15-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/SqlJson/*' />
15+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/SqlJson/*' />
1616
public class SqlJson : INullable
1717
{
1818
// Our serialized JSON string, or null.
1919
private readonly string? _jsonString = null;
2020

21-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ctor1/*' />
21+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ctor1/*' />
2222
public SqlJson()
2323
{
2424
}
2525

26-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ctor2/*' />
26+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ctor2/*' />
2727
#if NET
2828
public SqlJson([StringSyntax(StringSyntaxAttribute.Json)] string? jsonString)
2929
#else
@@ -45,7 +45,7 @@ public SqlJson(string? jsonString)
4545
_jsonString = jsonString;
4646
}
4747

48-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ctor3/*' />
48+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ctor3/*' />
4949
public SqlJson(JsonDocument? jsonDoc)
5050
{
5151
if (jsonDoc == null)
@@ -57,13 +57,13 @@ public SqlJson(JsonDocument? jsonDoc)
5757
_jsonString = jsonDoc.RootElement.GetRawText();
5858
}
5959

60-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/IsNull/*' />
60+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/IsNull/*' />
6161
public bool IsNull => _jsonString is null;
6262

63-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/Null/*' />
63+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/Null/*' />
6464
public static SqlJson Null => new();
6565

66-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/Value/*' />
66+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/Value/*' />
6767
public string Value
6868
{
6969
get
@@ -77,7 +77,7 @@ public string Value
7777
}
7878
}
7979

80-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ToString/*' />
80+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlJson.xml' path='docs/members[@name="SqlJson"]/ToString/*' />
8181
public override string? ToString()
8282
{
8383
return _jsonString;

‎src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Licensed to the .NET Foundation under one or more agreements.
1+
// Licensed to the .NET Foundation under one or more agreements.
22
// The .NET Foundation licenses this file to you under the MIT license.
33
// See the LICENSE file in the project root for more information.
44

@@ -15,7 +15,7 @@
1515

1616
namespace Microsoft.Data.SqlTypes;
1717

18-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/SqlVector/*' />
18+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/SqlVector/*' />
1919
public readonly struct SqlVector<T> : INullable, ISqlVector
2020
where T : unmanaged
2121
{
@@ -55,10 +55,10 @@ private SqlVector(int length)
5555
Memory = new();
5656
}
5757

58-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/CreateNull/*' />
58+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/CreateNull/*' />
5959
public static SqlVector<T> CreateNull(int length) => new(length);
6060

61-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/ctor1/*' />
61+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/ctor1/*' />
6262
public SqlVector(ReadOnlyMemory<T> memory)
6363
{
6464
(_elementType, _elementSize) = GetTypeFieldsOrThrow();
@@ -101,16 +101,16 @@ internal string GetString()
101101

102102
#region Properties
103103

104-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/IsNull/*' />
104+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/IsNull/*' />
105105
public bool IsNull { get; }
106106

107-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/Null/*' />
107+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/Null/*' />
108108
public static SqlVector<T>? Null => null;
109109

110-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/Length/*' />
110+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/Length/*' />
111111
public int Length { get; }
112112

113-
/// <include file='../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/Memory/*' />
113+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml' path='docs/members[@name="SqlVector"]/Memory/*' />
114114
public ReadOnlyMemory<T> Memory { get; }
115115

116116
#endregion

0 commit comments

Comments
 (0)