Skip to content

Commit d3c29e0

Browse files
DmitryLukyanovDmitryLukyanov
committed
CSHARP-2774: Fix sandcastle warnings.
1 parent 5d89fe5 commit d3c29e0

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

‎Docs/Api/CSharpDriverDocs.shfbproj

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various BSON and base .Net types</NamespaceSummaryItem>
4646
<NamespaceSummaryItem name="MongoDB.Driver" isDocumented="True">The MongoDB.Driver namespace contains all the basic types and classes that compose the MongoDB driver. It contains the classes needed for most interactions with the database.</NamespaceSummaryItem>
4747
<NamespaceSummaryItem name="MongoDB.Driver.Builders" isDocumented="True">The MongoDB.Driver.Builders namespace contains helper classes (builders) that can be used to construct various options used in the driver.</NamespaceSummaryItem>
48+
<NamespaceSummaryItem name="MongoDB.Driver.Encryption" isDocumented="True">The MongoDB.Driver.Encryption namespace contains all the basic types and classes related to client-side encryption.</NamespaceSummaryItem>
4849
<NamespaceSummaryItem name="MongoDB.Driver.GridFS" isDocumented="True">The classes used to interact with MongoDB GridFS are part of the MongoDB.Driver.GridFS namespace.</NamespaceSummaryItem>
4950
<NamespaceSummaryItem name="MongoDB.Driver.Internal" isDocumented="True">The MongoDB.Driver.Internal namespace contains internal classes used by the driver such as ConnectionPool.</NamespaceSummaryItem>
5051
<NamespaceSummaryItem name="MongoDB.Driver.Wrappers" isDocumented="True">Wrapped versions of various classes for use in serialization are present in the MongoDB.Driver.Wrappers namespace.</NamespaceSummaryItem>
@@ -106,6 +107,15 @@
106107
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
107108
<CppCommentsFixup>False</CppCommentsFixup>
108109
<CleanIntermediates>True</CleanIntermediates>
110+
<PlugInConfigurations>
111+
<PlugInConfig id="Additional Reference Links" enabled="True">
112+
<configuration>
113+
<targets>
114+
<target htmlSdkLinkType="None" helpViewerSdkLinkType="Id" websiteSdkLinkType="None" helpFileProject="LibMongocryptDocs.shfbproj" />
115+
</targets>
116+
</configuration>
117+
</PlugInConfig>
118+
</PlugInConfigurations>
109119
</PropertyGroup>
110120
<!-- There are no properties for these groups. AnyCPU needs to appear in
111121
order for Visual Studio to perform the build. The others are optional

‎Docs/Api/LibMongocryptDocs.shfbproj

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
3+
<PropertyGroup>
4+
<!-- The configuration and platform will be used to determine which assemblies to include from solution and
5+
project documentation sources -->
6+
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
7+
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
8+
<SchemaVersion>2.0</SchemaVersion>
9+
<ProjectGuid>{d1025c62-a1f2-4b7b-b88e-a57e57f08d02}</ProjectGuid>
10+
<SHFBSchemaVersion>1.9.9.0</SHFBSchemaVersion>
11+
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
12+
<AssemblyName>Documentation</AssemblyName>
13+
<RootNamespace>Documentation</RootNamespace>
14+
<Name>Documentation</Name>
15+
<!-- SHFB properties -->
16+
<OutputPath>.\Help\</OutputPath>
17+
<HtmlHelpName>LibMongocryptDocs</HtmlHelpName>
18+
<Language>en-US</Language>
19+
<DocumentationSources>
20+
<DocumentationSource sourceFile="..\..\artifacts\bin\net452\MongoDB.Libmongocrypt.dll" />
21+
</DocumentationSources>
22+
</PropertyGroup>
23+
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
24+
the build. The others are optional common platform types that may appear. -->
25+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
26+
</PropertyGroup>
27+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
28+
</PropertyGroup>
29+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
30+
</PropertyGroup>
31+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
32+
</PropertyGroup>
33+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
34+
</PropertyGroup>
35+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
36+
</PropertyGroup>
37+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
38+
</PropertyGroup>
39+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
40+
</PropertyGroup>
41+
<!-- Import the SHFB build targets -->
42+
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
43+
</Project>

‎src/MongoDB.Driver/Encryption/ClientEncryptionOptions.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ public ClientEncryptionOptions(
7878
/// <param name="keyVaultClient">The key vault client.</param>
7979
/// <param name="keyVaultNamespace">The key vault namespace.</param>
8080
/// <param name="kmsProviders">The KMS providers.</param>
81+
/// <returns>A new ClientEncryptionOptions instance.</returns>
8182
public ClientEncryptionOptions With(
8283
Optional<IMongoClient> keyVaultClient = default,
8384
Optional<CollectionNamespace> keyVaultNamespace = default,

‎src/MongoDB.Driver/IAggregateFluent.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ IAggregateFluent<TNewResult> Lookup<TForeignDocument, TAsElement, TAs, TNewResul
237237
/// <summary>
238238
/// Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
239239
/// </summary>
240+
/// <typeparam name="TOutput">The type of output documents.</typeparam>
240241
/// <param name="outputCollection">The output collection.</param>
241242
/// <param name="mergeOptions">The merge options.</param>
242243
/// <param name="cancellationToken">The cancellation token.</param>
@@ -246,6 +247,7 @@ IAggregateFluent<TNewResult> Lookup<TForeignDocument, TAsElement, TAs, TNewResul
246247
/// <summary>
247248
/// Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
248249
/// </summary>
250+
/// <typeparam name="TOutput">The type of output documents.</typeparam>
249251
/// <param name="outputCollection">The output collection.</param>
250252
/// <param name="mergeOptions">The merge options.</param>
251253
/// <param name="cancellationToken">The cancellation token.</param>

0 commit comments

Comments
 (0)