Skip to content

Commit 8ad29b0

Browse files
committed
COH-30705 Generate XML documentation
[git-p4: depot-paths = "//dev/main.net/": change = 110804]
1 parent b1da2db commit 8ad29b0

File tree

7 files changed

+21
-11
lines changed

7 files changed

+21
-11
lines changed

src/Coherence.SessionStore/Coherence.SessionStore.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,14 @@
1919
<OutputPath>bin\Debug/</OutputPath>
2020
<WarningLevel>4</WarningLevel>
2121
<NoWarn />
22+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2223
</PropertyGroup>
2324

2425
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
2526
<OutputPath>bin\Release/</OutputPath>
2627
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
2728
<WarningLevel>4</WarningLevel>
29+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2830
</PropertyGroup>
2931

3032
<ItemGroup>

src/Coherence.SessionStore/Web/CoherenceSessionOptions.cs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ public class CoherenceSessionOptions
3636
/// <summary>
3737
/// Path to the Coherence configuration file.
3838
/// </summary>
39-
public string CoherenceConfig { get; set; } = "assembly://Coherence/Tangosol.Config/coherence.xml";
39+
public string CoherenceConfig { get; set; } = "assembly://Coherence/Tangosol.Config/coherence-config.xml";
40+
4041
/// <summary>
4142
/// Path to the Coherence cache configuration file.
4243
/// </summary>
@@ -57,7 +58,14 @@ public class CoherenceSessionOptions
5758
/// </summary>
5859
public enum SessionModel
5960
{
61+
/// <summary>
62+
/// Monolithic session model
63+
/// </summary>
6064
Monolithic,
65+
66+
/// <summary>
67+
/// Split session model
68+
/// </summary>
6169
Split
6270
}
6371
}

src/Coherence/Coherence.csproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,12 @@
6060
<DefineConstants>DEBUG;TRACE</DefineConstants>
6161
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
6262
<WarningsAsErrors />
63-
<GenerateDocumentationFile>false</GenerateDocumentationFile>
63+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
6464
<OutputPath>bin\Debug</OutputPath>
6565
</PropertyGroup>
6666
<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|net6.0|AnyCPU'">
6767
<DefineConstants />
68-
<GenerateDocumentationFile>false</GenerateDocumentationFile>
68+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
6969
<OutputPath>bin\Release</OutputPath>
7070
</PropertyGroup>
7171

@@ -78,7 +78,7 @@
7878
<None Remove="Config\cache-config.xsd" />
7979
<None Remove="Config\coherence-cache-config.xml" />
8080
<None Remove="Config\pof-config.xsd" />
81-
<None Remove="Config\coherence.xml" />
81+
<None Remove="Config\coherence-config.xml" />
8282
<None Remove="Config\coherence-pof-config.xml" />
8383
<None Remove="Config\coherence.xsd" />
8484
</ItemGroup>
@@ -87,7 +87,7 @@
8787
<EmbeddedResource Include="Config\cache-config.xsd" />
8888
<EmbeddedResource Include="Config\coherence-cache-config.xml" />
8989
<EmbeddedResource Include="Config\pof-config.xsd" />
90-
<EmbeddedResource Include="Config\coherence.xml" />
90+
<EmbeddedResource Include="Config\coherence-config.xml" />
9191
<EmbeddedResource Include="Config\coherence-pof-config.xml" />
9292
<EmbeddedResource Include="Config\coherence.xsd" />
9393
</ItemGroup>

src/Coherence/Config/coherence.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
<xs:complexType name="cluster-config">
9696
<xs:sequence>
9797
<xs:element ref="member-identity" minOccurs="0"/>
98-
<xs:element ref="filters"/>
98+
<xs:element ref="filters" minOccurs="0"/>
9999
<xs:element ref="serializers" minOccurs="0"/>
100100
<xs:element ref="address-providers" minOccurs="0"/>
101101
</xs:sequence>

src/Coherence/Net/CacheFactory.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ public static bool IsLogEnabled(LogLevel level)
716716

717717
/// <summary>
718718
/// Log a message using Coherence logging facility which is driven by
719-
/// the "logging-config" element located in the coherence.xml
719+
/// the "logging-config" element located in the coherence-config.xml
720720
/// configuration file.
721721
/// </summary>
722722
/// <param name="message">
@@ -733,7 +733,7 @@ public static void Log(string message, LogLevel severity)
733733

734734
/// <summary>
735735
/// Log an exception using Coherence logging facility which is driven
736-
/// by the "logging-config" element located in the coherence.xml
736+
/// by the "logging-config" element located in the coherence-config.xml
737737
/// configuration file.
738738
/// </summary>
739739
/// <param name="exc">
@@ -751,7 +751,7 @@ public static void Log(Exception exc, LogLevel severity)
751751
/// <summary>
752752
/// Log a message and exception using Coherence logging facility
753753
/// which is driven by the "logging-config" element located in the
754-
/// coherence.xml configuration file.
754+
/// coherence-config.xml configuration file.
755755
/// </summary>
756756
/// <param name="message">
757757
/// A message to log.

src/Coherence/Net/DefaultOperationalContext.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,14 @@ public virtual IXmlElement Config
8888
/// </summary>
8989
static DefaultOperationalContext()
9090
{
91-
s_configResource = ResourceLoader.GetResource("coherence.xml", true);
91+
s_configResource = ResourceLoader.GetResource("coherence-config.xml", true);
9292

9393
// if the user-specific default operaational configuration file
9494
// doesn't exist, use the one embedded into Coherence.dll
9595
if (!File.Exists(s_configResource.AbsolutePath))
9696
{
9797
s_configResource = new EmbeddedResource(string.Format(
98-
"assembly://{0}/Tangosol.Config/coherence.xml",
98+
"assembly://{0}/Tangosol.Config/coherence-config.xml",
9999
typeof(CacheFactory).Assembly.FullName));
100100
}
101101
}

0 commit comments

Comments
 (0)