Skip to content

Commit 46e6bae

Browse files
sharwellsharwell
committed
Merge pull request #335 from sharwell/documentation-fixes
Documentation fixes
2 parents c751f91 + f278367 commit 46e6bae

File tree

73 files changed

+301
-82
lines changed

Some content is hidden

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

73 files changed

+301
-82
lines changed

‎src/Documentation/AdditionalReferenceDocumentation.shfbproj‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
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>1d084ab3-e5db-4a72-9daf-e51d225d5fcf</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>AdditionalReferenceDocumentation</AssemblyName>
13+
<RootNamespace>AdditionalReferenceDocumentation</RootNamespace>
14+
<Name>AdditionalReferenceDocumentation</Name>
15+
<!-- SHFB properties -->
16+
<FrameworkVersion>.NET Framework 4.0</FrameworkVersion>
17+
<OutputPath>.\Help\</OutputPath>
18+
<HtmlHelpName>AdditionalReferenceDocumentation</HtmlHelpName>
19+
<Language>en-US</Language>
20+
<TransformComponentArguments>
21+
<Argument Key="logoFile" Value="Help.png" xmlns="" />
22+
<Argument Key="logoHeight" Value="" xmlns="" />
23+
<Argument Key="logoWidth" Value="" xmlns="" />
24+
<Argument Key="logoAltText" Value="" xmlns="" />
25+
<Argument Key="logoPlacement" Value="left" xmlns="" />
26+
<Argument Key="logoAlignment" Value="left" xmlns="" />
27+
<Argument Key="maxVersionParts" Value="" xmlns="" />
28+
</TransformComponentArguments>
29+
<DocumentationSources>
30+
<DocumentationSource sourceFile="..\packages\Newtonsoft.Json.5.0.6\lib\net40\Newtonsoft.Json.dll" />
31+
<DocumentationSource sourceFile="..\packages\Newtonsoft.Json.5.0.6\lib\net40\Newtonsoft.Json.xml" />
32+
<DocumentationSource sourceFile="..\packages\SimpleRESTServices.1.3.0.1\lib\net40\SimpleRESTServices.dll" />
33+
<DocumentationSource sourceFile="..\packages\SimpleRESTServices.1.3.0.1\lib\net40\SimpleRESTServices.xml" />
34+
</DocumentationSources>
35+
</PropertyGroup>
36+
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
37+
the build. The others are optional common platform types that may appear. -->
38+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
39+
</PropertyGroup>
40+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
41+
</PropertyGroup>
42+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
43+
</PropertyGroup>
44+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
45+
</PropertyGroup>
46+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
47+
</PropertyGroup>
48+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
49+
</PropertyGroup>
50+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
51+
</PropertyGroup>
52+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
53+
</PropertyGroup>
54+
<!-- Import the SHFB build targets -->
55+
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
56+
</Project>

‎src/Documentation/Documentation.v3.5.shfbproj‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@
5858
</TransformComponentArguments>
5959
<ComponentConfigurations>
6060
<ComponentConfig id="IntelliSense Component" enabled="True">
61-
<component id="IntelliSense Component" type="Microsoft.Ddue.Tools.IntelliSenseComponent" assembly="{@SandcastlePath}ProductionTools\BuildComponents.dll">
61+
<component id="IntelliSense Component">
6262
<output includeNamespaces="false" namespacesFile="Namespaces" folder="{@OutputFolder}\..\..\Api\v3.5" />
6363
</component>
6464
</ComponentConfig>
6565
<ComponentConfig id="Code Block Component" enabled="True">
66-
<component id="Code Block Component" type="SandcastleBuilder.Components.CodeBlockComponent" assembly="{@SHFBFolder}SandcastleBuilder.Components.dll">
66+
<component id="Code Block Component">
6767
<basePath value="{@HtmlEncProjectFolder}" />
6868
<outputPaths>{@HelpFormatOutputPaths}</outputPaths>
6969
<allowMissingSource value="false" />
@@ -72,7 +72,7 @@
7272
</component>
7373
</ComponentConfig>
7474
<ComponentConfig id="API Token Resolution" enabled="True">
75-
<component id="API Token Resolution" type="Microsoft.Ddue.Tools.SharedContentComponent" assembly="{@SandcastlePath}ProductionTools\BuildComponents.dll">
75+
<component id="API Token Resolution">
7676
{@TokenFiles}
7777
<replace elements="/*//token" item="string(.)" />
7878
</component>
@@ -95,6 +95,13 @@
9595
<PlugInConfig id="Lightweight TOC" enabled="True">
9696
<configuration />
9797
</PlugInConfig>
98+
<PlugInConfig id="Additional Reference Links" enabled="True">
99+
<configuration>
100+
<targets>
101+
<target htmlSdkLinkType="None" help2SdkLinkType="Index" helpViewerSdkLinkType="Id" websiteSdkLinkType="None" helpFileProject="AdditionalReferenceDocumentation.shfbproj" />
102+
</targets>
103+
</configuration>
104+
</PlugInConfig>
98105
</PlugInConfigurations>
99106
<BuildLogFile />
100107
<HtmlHelp1xCompilerPath />

‎src/Documentation/Documentation.v4.0.shfbproj‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@
5858
</TransformComponentArguments>
5959
<ComponentConfigurations>
6060
<ComponentConfig id="IntelliSense Component" enabled="True">
61-
<component id="IntelliSense Component" type="Microsoft.Ddue.Tools.IntelliSenseComponent" assembly="{@SandcastlePath}ProductionTools\BuildComponents.dll">
61+
<component id="IntelliSense Component">
6262
<output includeNamespaces="false" namespacesFile="Namespaces" folder="{@OutputFolder}\..\..\Api\v4.0" />
6363
</component>
6464
</ComponentConfig>
6565
<ComponentConfig id="Code Block Component" enabled="True">
66-
<component id="Code Block Component" type="SandcastleBuilder.Components.CodeBlockComponent" assembly="{@SHFBFolder}SandcastleBuilder.Components.dll">
66+
<component id="Code Block Component">
6767
<basePath value="{@HtmlEncProjectFolder}" />
6868
<outputPaths>{@HelpFormatOutputPaths}</outputPaths>
6969
<allowMissingSource value="false" />
@@ -72,9 +72,10 @@
7272
</component>
7373
</ComponentConfig>
7474
<ComponentConfig id="API Token Resolution" enabled="True">
75-
<component id="API Token Resolution" type="Microsoft.Ddue.Tools.SharedContentComponent" assembly="{@SandcastlePath}ProductionTools\BuildComponents.dll">
75+
<component id="API Token Resolution">
7676
{@TokenFiles}
77-
<replace elements="/*//token" item="string(.)" /></component>
77+
<replace elements="/*//token" item="string(.)" />
78+
</component>
7879
</ComponentConfig>
7980
</ComponentConfigurations>
8081
<CatalogName>VisualStudio11</CatalogName>
@@ -99,6 +100,13 @@
99100
<PlugInConfig id="Lightweight TOC" enabled="True">
100101
<configuration />
101102
</PlugInConfig>
103+
<PlugInConfig id="Additional Reference Links" enabled="True">
104+
<configuration>
105+
<targets>
106+
<target htmlSdkLinkType="None" help2SdkLinkType="Index" helpViewerSdkLinkType="Id" websiteSdkLinkType="None" helpFileProject="AdditionalReferenceDocumentation.shfbproj" />
107+
</targets>
108+
</configuration>
109+
</PlugInConfig>
102110
</PlugInConfigurations>
103111
<ApiFilter />
104112
<HelpAttributes />

‎src/corelib/Core/Collections/NamespaceDoc.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
namespace net.openstack.Core.Collections
2+
{
3+
using System.Runtime.CompilerServices;
4+
5+
/// <summary>
6+
/// The <see cref="net.openstack.Core.Collections"/> namespace contains interfaces and
7+
/// classes that extend the collections support provided by the base class library.
8+
/// </summary>
9+
[CompilerGenerated]
10+
internal class NamespaceDoc
11+
{
12+
}
13+
}

‎src/corelib/Core/Collections/ReadOnlyDictionary`2.cs‎

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ ICollection IDictionary.Values
171171
}
172172
}
173173

174+
/// <inheritdoc/>
174175
bool ICollection<KeyValuePair<TKey, TValue>>.IsReadOnly
175176
{
176177
get
@@ -179,6 +180,7 @@ bool ICollection<KeyValuePair<TKey, TValue>>.IsReadOnly
179180
}
180181
}
181182

183+
/// <inheritdoc/>
182184
bool IDictionary.IsFixedSize
183185
{
184186
get
@@ -187,6 +189,7 @@ bool IDictionary.IsFixedSize
187189
}
188190
}
189191

192+
/// <inheritdoc/>
190193
bool IDictionary.IsReadOnly
191194
{
192195
get
@@ -195,6 +198,7 @@ bool IDictionary.IsReadOnly
195198
}
196199
}
197200

201+
/// <inheritdoc/>
198202
bool ICollection.IsSynchronized
199203
{
200204
get
@@ -203,6 +207,7 @@ bool ICollection.IsSynchronized
203207
}
204208
}
205209

210+
/// <inheritdoc/>
206211
object ICollection.SyncRoot
207212
{
208213
get
@@ -239,6 +244,7 @@ public bool ContainsKey(TKey key)
239244
return _dictionary.ContainsKey(key);
240245
}
241246

247+
/// <inheritdoc/>
242248
bool IDictionary.Contains(object key)
243249
{
244250
if (key == null)
@@ -286,56 +292,67 @@ public bool TryGetValue(TKey key, out TValue value)
286292
return _dictionary.TryGetValue(key, out value);
287293
}
288294

295+
/// <inheritdoc/>
289296
void IDictionary<TKey, TValue>.Add(TKey key, TValue value)
290297
{
291298
throw new NotSupportedException();
292299
}
293300

301+
/// <inheritdoc/>
294302
void IDictionary.Add(object key, object value)
295303
{
296304
throw new NotSupportedException();
297305
}
298306

307+
/// <inheritdoc/>
299308
bool IDictionary<TKey, TValue>.Remove(TKey key)
300309
{
301310
throw new NotSupportedException();
302311
}
303312

313+
/// <inheritdoc/>
304314
void IDictionary.Remove(object key)
305315
{
306316
throw new NotSupportedException();
307317
}
308318

319+
/// <inheritdoc/>
309320
void ICollection<KeyValuePair<TKey, TValue>>.Add(KeyValuePair<TKey, TValue> item)
310321
{
311322
throw new NotSupportedException();
312323
}
313324

325+
/// <inheritdoc/>
314326
void ICollection<KeyValuePair<TKey, TValue>>.Clear()
315327
{
316328
throw new NotSupportedException();
317329
}
318330

331+
/// <inheritdoc/>
319332
bool ICollection<KeyValuePair<TKey, TValue>>.Contains(KeyValuePair<TKey, TValue> item)
320333
{
321334
throw new NotImplementedException();
322335
}
323336

337+
/// <inheritdoc/>
324338
void ICollection<KeyValuePair<TKey, TValue>>.CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)
325339
{
326340
throw new NotImplementedException();
327341
}
328342

343+
/// <inheritdoc/>
329344
bool ICollection<KeyValuePair<TKey, TValue>>.Remove(KeyValuePair<TKey, TValue> item)
330345
{
331346
throw new NotSupportedException();
332347
}
333348

349+
/// <inheritdoc/>
334350
void IDictionary.Clear()
335351
{
336352
throw new NotSupportedException();
337353
}
338354

355+
/// <inheritdoc/>
339356
void ICollection.CopyTo(Array array, int index)
340357
{
341358
throw new NotImplementedException();
@@ -379,6 +396,7 @@ public int Count
379396
}
380397
}
381398

399+
/// <inheritdoc/>
382400
bool ICollection<TKey>.IsReadOnly
383401
{
384402
get
@@ -387,6 +405,7 @@ bool ICollection<TKey>.IsReadOnly
387405
}
388406
}
389407

408+
/// <inheritdoc/>
390409
bool ICollection.IsSynchronized
391410
{
392411
get
@@ -395,6 +414,7 @@ bool ICollection.IsSynchronized
395414
}
396415
}
397416

417+
/// <inheritdoc/>
398418
object ICollection.SyncRoot
399419
{
400420
get
@@ -422,6 +442,7 @@ public void CopyTo(TKey[] array, int arrayIndex)
422442
_keys.CopyTo(array, arrayIndex);
423443
}
424444

445+
/// <inheritdoc/>
425446
void ICollection.CopyTo(Array array, int index)
426447
{
427448
throw new NotImplementedException();
@@ -442,21 +463,25 @@ IEnumerator IEnumerable.GetEnumerator()
442463
return GetEnumerator();
443464
}
444465

445-
bool ICollection<TKey>.Contains(TKey value)
466+
/// <inheritdoc/>
467+
bool ICollection<TKey>.Contains(TKey item)
446468
{
447-
return _keys.Contains(value);
469+
return _keys.Contains(item);
448470
}
449471

450-
void ICollection<TKey>.Add(TKey value)
472+
/// <inheritdoc/>
473+
void ICollection<TKey>.Add(TKey item)
451474
{
452475
throw new NotSupportedException();
453476
}
454477

455-
bool ICollection<TKey>.Remove(TKey value)
478+
/// <inheritdoc/>
479+
bool ICollection<TKey>.Remove(TKey item)
456480
{
457481
throw new NotSupportedException();
458482
}
459483

484+
/// <inheritdoc/>
460485
void ICollection<TKey>.Clear()
461486
{
462487
throw new NotSupportedException();
@@ -501,6 +526,7 @@ public int Count
501526
}
502527
}
503528

529+
/// <inheritdoc/>
504530
bool ICollection<TValue>.IsReadOnly
505531
{
506532
get
@@ -509,6 +535,7 @@ bool ICollection<TValue>.IsReadOnly
509535
}
510536
}
511537

538+
/// <inheritdoc/>
512539
bool ICollection.IsSynchronized
513540
{
514541
get
@@ -517,6 +544,7 @@ bool ICollection.IsSynchronized
517544
}
518545
}
519546

547+
/// <inheritdoc/>
520548
object ICollection.SyncRoot
521549
{
522550
get
@@ -544,6 +572,7 @@ public void CopyTo(TValue[] array, int arrayIndex)
544572
_values.CopyTo(array, arrayIndex);
545573
}
546574

575+
/// <inheritdoc/>
547576
void ICollection.CopyTo(Array array, int index)
548577
{
549578
throw new NotImplementedException();
@@ -564,21 +593,25 @@ IEnumerator IEnumerable.GetEnumerator()
564593
return GetEnumerator();
565594
}
566595

567-
bool ICollection<TValue>.Contains(TValue value)
596+
/// <inheritdoc/>
597+
bool ICollection<TValue>.Contains(TValue item)
568598
{
569-
return _values.Contains(value);
599+
return _values.Contains(item);
570600
}
571601

572-
void ICollection<TValue>.Add(TValue value)
602+
/// <inheritdoc/>
603+
void ICollection<TValue>.Add(TValue item)
573604
{
574605
throw new NotSupportedException();
575606
}
576607

577-
bool ICollection<TValue>.Remove(TValue value)
608+
/// <inheritdoc/>
609+
bool ICollection<TValue>.Remove(TValue item)
578610
{
579611
throw new NotSupportedException();
580612
}
581613

614+
/// <inheritdoc/>
582615
void ICollection<TValue>.Clear()
583616
{
584617
throw new NotSupportedException();

‎src/corelib/Core/Domain/AuthenticationType.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ private AuthenticationType(string name) : base(name)
3030
/// Gets the <see cref="AuthenticationType"/> instance with the specified name.
3131
/// </summary>
3232
/// <param name="name">The name.</param>
33+
/// <returns>The unique <see cref="AuthenticationType"/> instance with the specified name.</returns>
3334
/// <exception cref="ArgumentNullException">If <paramref name="name"/> is <see langword="null"/>.</exception>
3435
/// <exception cref="ArgumentException">If <paramref name="name"/> is empty.</exception>
3536
public static AuthenticationType FromName(string name)

0 commit comments

Comments
 (0)