Skip to content

Commit 2f0e3b3

Browse files
Document the process of creating docs with doxygen (#4743)
* Doxygen experimentation * Substantial improvements to output * Fix documentation warnings from doxygen * #4742 Document use of doxygen for doc creation * Revert to using cref and live with doxygen warnings * Update Polyfill package version
1 parent 4f1d085 commit 2f0e3b3

40 files changed

+219
-96
lines changed

Source/Csla.Analyzers/Csla.Analyzers/Csla.Analyzers.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0" PrivateAssets="all" />
1616
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.10.0" PrivateAssets="all" />
1717
<PackageReference Update="NETStandard.Library" PrivateAssets="all" />
18-
<PackageReference Include="Polyfill" Version="7.4.0">
18+
<PackageReference Include="Polyfill" Version="8.9.0">
1919
<PrivateAssets>all</PrivateAssets>
2020
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
2121
</PackageReference>

Source/Csla.Blazor/State/NoOpSessionManager.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ public Session GetCachedSession()
3131
/// <exception cref="NotSupportedException"></exception>
3232
public Session GetSession()
3333
{ throw new NotSupportedException(); }
34-
/// <summary>
35-
/// Not supported
36-
/// </summary>
37-
/// <returns></returns>
38-
/// <exception cref="NotSupportedException"></exception>
39-
public void PurgeSessions(TimeSpan expiration)
34+
/// <summary>
35+
/// Not supported.
36+
/// </summary>
37+
/// <param name="expiration">Unused expiration value.</param>
38+
/// <exception cref="NotSupportedException"></exception>
39+
public void PurgeSessions(TimeSpan expiration)
4040
{ throw new NotSupportedException(); }
4141
/// <summary>
4242
/// Not supported

Source/Csla.Blazor/State/StateManager.cs

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,29 @@
66
// <summary>Get and save state from Blazor pages</summary>
77
//-----------------------------------------------------------------------
88

9+
using System;
10+
using System.Threading;
11+
using System.Threading.Tasks;
912
using Csla.State;
1013

1114
namespace Csla.Blazor.State
1215
{
1316
/// <summary>
1417
/// Get and save state from Blazor pages.
1518
/// </summary>
16-
/// <param name="sessionManager">The session manager to use for state management.</param>
17-
public class StateManager(ISessionManager sessionManager)
19+
public class StateManager
1820
{
19-
private readonly ISessionManager _sessionManager = sessionManager;
21+
private readonly ISessionManager _sessionManager;
22+
23+
/// <summary>
24+
/// Initializes a new instance of the <see cref="StateManager"/> class.
25+
/// </summary>
26+
/// <param name="sessionManager">Session manager implementation used to persist page state.</param>
27+
/// <exception cref="ArgumentNullException"><paramref name="sessionManager"/> is <see langword="null"/>.</exception>
28+
public StateManager(ISessionManager sessionManager)
29+
{
30+
_sessionManager = sessionManager ?? throw new ArgumentNullException(nameof(sessionManager));
31+
}
2032

2133
/// <summary>
2234
/// Get state from cache.

Source/Csla.Channels.RabbitMq/Csla.Channels.RabbitMq.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</ItemGroup>
1717

1818
<ItemGroup Condition="'$(TargetFramework)'=='netstandard2.1'">
19-
<PackageReference Include="Polyfill" Version="7.4.0">
19+
<PackageReference Include="Polyfill" Version="8.9.0">
2020
<PrivateAssets>all</PrivateAssets>
2121
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
2222
</PackageReference>

Source/Csla.Generators/cs/AutoImplementProperties/Csla.Generator.AutoImplementProperties.CSharp/Csla.Generator.AutoImplementProperties.CSharp.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<ProjectReference Include="..\Csla.Generator.AutoImplementProperties.Attributes.CSharp\Csla.Generator.AutoImplementProperties.Attributes.CSharp.csproj" PrivateAssets="All" />
4747
</ItemGroup>
4848
<ItemGroup>
49-
<PackageReference Include="Polyfill" Version="7.4.0">
49+
<PackageReference Include="Polyfill" Version="8.9.0">
5050
<PrivateAssets>all</PrivateAssets>
5151
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
5252
</PackageReference>

Source/Csla.Generators/cs/AutoSerialization/Csla.Generator.AutoSerialization.CSharp/Csla.Generator.AutoSerialization.CSharp.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
</ItemGroup>
4343

4444
<ItemGroup>
45-
<PackageReference Include="Polyfill" Version="7.4.0">
45+
<PackageReference Include="Polyfill" Version="8.9.0">
4646
<PrivateAssets>all</PrivateAssets>
4747
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
4848
</PackageReference>

Source/Csla.Web/Design/CslaDesignerDataSourceView.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public override IEnumerable GetDesignTimeData(int minimumRows, out bool isSample
9090
/// </summary>
9191
/// <remarks>
9292
/// All public properties are returned except for those marked
93-
/// with the <see cref="BrowsableAttribute">Browsable attribute</see>
93+
/// with the <see cref="System.ComponentModel.BrowsableAttribute">Browsable attribute</see>
9494
/// as False.
9595
/// </remarks>
9696
public override IDataSourceViewSchema Schema =>

Source/Csla.Web/Design/ObjectFieldInfo.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public ObjectFieldInfo(PropertyDescriptor field)
6666
/// </summary>
6767
/// <remarks>
6868
/// Returns the optional value provided through
69-
/// the <see cref="DataObjectFieldAttribute">DataObjectField</see>
69+
/// the <see cref="System.ComponentModel.DataObjectFieldAttribute">DataObjectField</see>
7070
/// attribute on the property.
7171
/// </remarks>
7272
public bool Identity { get; }
@@ -93,7 +93,7 @@ public ObjectFieldInfo(PropertyDescriptor field)
9393
/// </summary>
9494
/// <remarks>
9595
/// Returns the optional value provided through
96-
/// the <see cref="DataObjectFieldAttribute">DataObjectField</see>
96+
/// the <see cref="System.ComponentModel.DataObjectFieldAttribute">DataObjectField</see>
9797
/// attribute on the property.
9898
/// </remarks>
9999
public int Length { get; }
@@ -111,7 +111,7 @@ public ObjectFieldInfo(PropertyDescriptor field)
111111
/// Returns True for reference types, and for
112112
/// value types wrapped in the Nullable generic.
113113
/// The result can also be set to True through
114-
/// the <see cref="DataObjectFieldAttribute">DataObjectField</see>
114+
/// the <see cref="System.ComponentModel.DataObjectFieldAttribute">DataObjectField</see>
115115
/// attribute on the property.
116116
/// </remarks>
117117
public bool Nullable { get; }
@@ -128,7 +128,7 @@ public ObjectFieldInfo(PropertyDescriptor field)
128128
/// </summary>
129129
/// <remarks>
130130
/// Returns the optional value provided through
131-
/// the <see cref="DataObjectFieldAttribute">DataObjectField</see>
131+
/// the <see cref="System.ComponentModel.DataObjectFieldAttribute">DataObjectField</see>
132132
/// attribute on the property.
133133
/// </remarks>
134134
public bool PrimaryKey => IsUnique;

Source/Csla.Web/Design/ObjectViewSchema.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ public ObjectViewSchema(CslaDataSourceDesigner? site, string typeName)
5454
/// </summary>
5555
/// <remarks>All public properties on the object
5656
/// will be reflected in this schema list except
57-
/// for those properties where the
58-
/// <see cref="BrowsableAttribute">Browsable</see> attribute
57+
/// for those properties where the
58+
/// <see cref="System.ComponentModel.BrowsableAttribute">Browsable</see> attribute
5959
/// is False.
6060
/// </remarks>
6161
public IDataSourceFieldSchema[] GetFields()

Source/Csla.Windows/Csla.Windows.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</PropertyGroup>
1818

1919
<ItemGroup Condition="$(TargetFramework.StartsWith(&quot;net4&quot;))">
20-
<PackageReference Include="Polyfill" Version="7.4.0">
20+
<PackageReference Include="Polyfill" Version="8.9.0">
2121
<PrivateAssets>all</PrivateAssets>
2222
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
2323
</PackageReference>

0 commit comments

Comments
 (0)