Skip to content

Commit 3eef96f

Browse files
pwelter34pwelter34
committed
improve xml docs generated
1 parent 2fa5e25 commit 3eef96f

96 files changed

Lines changed: 2335 additions & 1212 deletions

File tree

Some content is hidden

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

‎sample/Tracker/Tracker.Core/Data/Entities/Audit.cs‎

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
using System;
22
using System.Collections.Generic;
3-
using Tracker.Core.Definitions;
3+
using System.ComponentModel.DataAnnotations;
4+
using System.ComponentModel.DataAnnotations.Schema;
45

56
namespace Tracker.Core.Data.Entities;
67

78
/// <summary>
8-
/// Entity class representing data for table 'Audit'.
9+
/// Represents the <c>Audit</c> entity mapped to the <c>dbo.Audit</c> table.
910
/// </summary>
10-
[System.ComponentModel.DataAnnotations.Schema.Table("Audit", Schema = "dbo")]
11-
public partial class Audit : IHaveIdentifier
11+
[Table("Audit", Schema = "dbo")]
12+
public partial class Audit
1213
{
1314
/// <summary>
1415
/// Initializes a new instance of the <see cref="Audit"/> class.
@@ -21,112 +22,112 @@ public Audit()
2122

2223
#region Generated Properties
2324
/// <summary>
24-
/// Gets or sets the property value representing column <c>Id</c>.
25+
/// Gets or sets the <c>Id</c> value mapped to the <c>Id</c> column.
2526
/// </summary>
2627
/// <value>
27-
/// The property value representing column <c>Id</c>.
28+
/// The <c>Id</c> entity value.
2829
/// </value>
2930
[Key]
3031
[Column("Id", TypeName = "uniqueidentifier")]
3132
public Guid Id { get; set; }
3233

3334
/// <summary>
34-
/// Gets or sets the property value representing column <c>Date</c>.
35+
/// Gets or sets the <c>Date</c> value mapped to the <c>Date</c> column.
3536
/// </summary>
3637
/// <value>
37-
/// The property value representing column <c>Date</c>.
38+
/// The <c>Date</c> entity value.
3839
/// </value>
3940
[Column("Date", TypeName = "datetime")]
4041
public DateTime Date { get; set; }
4142

4243
/// <summary>
43-
/// Gets or sets the property value representing column <c>UserId</c>.
44+
/// Gets or sets the <c>UserId</c> value mapped to the <c>UserId</c> column.
4445
/// </summary>
4546
/// <value>
46-
/// The property value representing column <c>UserId</c>.
47+
/// The <c>UserId</c> entity value.
4748
/// </value>
4849
[Column("UserId", TypeName = "uniqueidentifier")]
4950
public Guid? UserId { get; set; }
5051

5152
/// <summary>
52-
/// Gets or sets the property value representing column <c>TaskId</c>.
53+
/// Gets or sets the <c>TaskId</c> value mapped to the <c>TaskId</c> column.
5354
/// </summary>
5455
/// <value>
55-
/// The property value representing column <c>TaskId</c>.
56+
/// The <c>TaskId</c> entity value.
5657
/// </value>
5758
[Column("TaskId", TypeName = "uniqueidentifier")]
5859
public Guid? TaskId { get; set; }
5960

6061
/// <summary>
61-
/// Gets or sets the property value representing column <c>Content</c>.
62+
/// Gets or sets the <c>Content</c> value mapped to the <c>Content</c> column.
6263
/// </summary>
6364
/// <value>
64-
/// The property value representing column <c>Content</c>.
65+
/// The <c>Content</c> entity value.
6566
/// </value>
6667
[Column("Content", TypeName = "nvarchar(max)")]
6768
public string Content { get; set; } = null!;
6869

6970
/// <summary>
70-
/// Gets or sets the property value representing column <c>Username</c>.
71+
/// Gets or sets the <c>Username</c> value mapped to the <c>Username</c> column.
7172
/// </summary>
7273
/// <value>
73-
/// The property value representing column <c>Username</c>.
74+
/// The <c>Username</c> entity value.
7475
/// </value>
7576
[Column("Username", TypeName = "nvarchar(50)")]
7677
public string Username { get; set; } = null!;
7778

7879
/// <summary>
79-
/// Gets or sets the property value representing column <c>Created</c>.
80+
/// Gets or sets the <c>Created</c> value mapped to the <c>Created</c> column.
8081
/// </summary>
8182
/// <value>
82-
/// The property value representing column <c>Created</c>.
83+
/// The <c>Created</c> entity value.
8384
/// </value>
8485
[Column("Created", TypeName = "datetimeoffset")]
8586
public DateTimeOffset Created { get; set; }
8687

8788
/// <summary>
88-
/// Gets or sets the property value representing column <c>CreatedBy</c>.
89+
/// Gets or sets the <c>CreatedBy</c> value mapped to the <c>CreatedBy</c> column.
8990
/// </summary>
9091
/// <value>
91-
/// The property value representing column <c>CreatedBy</c>.
92+
/// The <c>CreatedBy</c> entity value.
9293
/// </value>
9394
[Column("CreatedBy", TypeName = "nvarchar(100)")]
9495
public string? CreatedBy { get; set; }
9596

9697
/// <summary>
97-
/// Gets or sets the property value representing column <c>Updated</c>.
98+
/// Gets or sets the <c>Updated</c> value mapped to the <c>Updated</c> column.
9899
/// </summary>
99100
/// <value>
100-
/// The property value representing column <c>Updated</c>.
101+
/// The <c>Updated</c> entity value.
101102
/// </value>
102103
[Column("Updated", TypeName = "datetimeoffset")]
103104
public DateTimeOffset Updated { get; set; }
104105

105106
/// <summary>
106-
/// Gets or sets the property value representing column <c>UpdatedBy</c>.
107+
/// Gets or sets the <c>UpdatedBy</c> value mapped to the <c>UpdatedBy</c> column.
107108
/// </summary>
108109
/// <value>
109-
/// The property value representing column <c>UpdatedBy</c>.
110+
/// The <c>UpdatedBy</c> entity value.
110111
/// </value>
111112
[Column("UpdatedBy", TypeName = "nvarchar(100)")]
112113
public string? UpdatedBy { get; set; }
113114

114115
/// <summary>
115-
/// Gets or sets the property value representing column <c>RowVersion</c>.
116+
/// Gets or sets the <c>RowVersion</c> value mapped to the <c>RowVersion</c> column.
116117
/// </summary>
117118
/// <value>
118-
/// The property value representing column <c>RowVersion</c>.
119+
/// The <c>RowVersion</c> entity value.
119120
/// </value>
120121
[ConcurrencyCheck]
121122
[Column("RowVersion", TypeName = "rowversion")]
122123
[DatabaseGenerated(DatabaseGeneratedOption.Computed)]
123124
public byte[] RowVersion { get; set; } = null!;
124125

125126
/// <summary>
126-
/// Gets or sets the property value representing column <c>Attributes</c>.
127+
/// Gets or sets the <c>Attributes</c> value mapped to the <c>Attributes</c> column.
127128
/// </summary>
128129
/// <value>
129-
/// The property value representing column <c>Attributes</c>.
130+
/// The <c>Attributes</c> entity value.
130131
/// </value>
131132
[Column("Attributes", TypeName = "StringList")]
132133
public string? Attributes { get; set; }

‎sample/Tracker/Tracker.Core/Data/Entities/Priority.cs‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
using System;
22
using System.Collections.Generic;
3-
4-
using Tracker.Core.Definitions;
3+
using System.ComponentModel.DataAnnotations;
4+
using System.ComponentModel.DataAnnotations.Schema;
55

66
namespace Tracker.Core.Data.Entities;
77

88
/// <summary>
9-
/// Entity class representing data for table 'Priority'.
9+
/// Represents the <c>Priority</c> entity mapped to the <c>dbo.Priority</c> table.
1010
/// </summary>
11-
[System.ComponentModel.DataAnnotations.Schema.Table("Priority", Schema = "dbo")]
12-
public partial class Priority : IHaveIdentifier, ITrackCreated, ITrackUpdated
11+
[Table("Priority", Schema = "dbo")]
12+
public partial class Priority
1313
{
1414
/// <summary>
15-
/// Initializes a new instance of the <see cref="Priority"/> class.
15+
/// Initializes a new instance of the <see cref="Priority"/> class and its collection navigation properties.
1616
/// </summary>
1717
public Priority()
1818
{
@@ -23,92 +23,92 @@ public Priority()
2323

2424
#region Generated Properties
2525
/// <summary>
26-
/// Gets or sets the property value representing column <c>Id</c>.
26+
/// Gets or sets the <c>Id</c> value mapped to the <c>Id</c> column.
2727
/// </summary>
2828
/// <value>
29-
/// The property value representing column <c>Id</c>.
29+
/// The <c>Id</c> entity value.
3030
/// </value>
3131
[Key]
3232
[Column("Id", TypeName = "uniqueidentifier")]
3333
public Guid Id { get; set; }
3434

3535
/// <summary>
36-
/// Gets or sets the property value representing column <c>Name</c>.
36+
/// Gets or sets the <c>Name</c> value mapped to the <c>Name</c> column.
3737
/// </summary>
3838
/// <value>
39-
/// The property value representing column <c>Name</c>.
39+
/// The <c>Name</c> entity value.
4040
/// </value>
4141
[Column("Name", TypeName = "nvarchar(100)")]
4242
public string Name { get; set; } = null!;
4343

4444
/// <summary>
45-
/// Gets or sets the property value representing column <c>Description</c>.
45+
/// Gets or sets the <c>Description</c> value mapped to the <c>Description</c> column.
4646
/// </summary>
4747
/// <value>
48-
/// The property value representing column <c>Description</c>.
48+
/// The <c>Description</c> entity value.
4949
/// </value>
5050
[Column("Description", TypeName = "nvarchar(255)")]
5151
public string? Description { get; set; }
5252

5353
/// <summary>
54-
/// Gets or sets the property value representing column <c>DisplayOrder</c>.
54+
/// Gets or sets the <c>DisplayOrder</c> value mapped to the <c>DisplayOrder</c> column.
5555
/// </summary>
5656
/// <value>
57-
/// The property value representing column <c>DisplayOrder</c>.
57+
/// The <c>DisplayOrder</c> entity value.
5858
/// </value>
5959
[Column("DisplayOrder", TypeName = "int")]
6060
public int DisplayOrder { get; set; }
6161

6262
/// <summary>
63-
/// Gets or sets the property value representing column <c>IsActive</c>.
63+
/// Gets or sets the <c>IsActive</c> value mapped to the <c>IsActive</c> column.
6464
/// </summary>
6565
/// <value>
66-
/// The property value representing column <c>IsActive</c>.
66+
/// The <c>IsActive</c> entity value.
6767
/// </value>
6868
[Column("IsActive", TypeName = "bit")]
6969
public bool IsActive { get; set; }
7070

7171
/// <summary>
72-
/// Gets or sets the property value representing column <c>Created</c>.
72+
/// Gets or sets the <c>Created</c> value mapped to the <c>Created</c> column.
7373
/// </summary>
7474
/// <value>
75-
/// The property value representing column <c>Created</c>.
75+
/// The <c>Created</c> entity value.
7676
/// </value>
7777
[Column("Created", TypeName = "datetimeoffset")]
7878
public DateTimeOffset Created { get; set; }
7979

8080
/// <summary>
81-
/// Gets or sets the property value representing column <c>CreatedBy</c>.
81+
/// Gets or sets the <c>CreatedBy</c> value mapped to the <c>CreatedBy</c> column.
8282
/// </summary>
8383
/// <value>
84-
/// The property value representing column <c>CreatedBy</c>.
84+
/// The <c>CreatedBy</c> entity value.
8585
/// </value>
8686
[Column("CreatedBy", TypeName = "nvarchar(100)")]
8787
public string? CreatedBy { get; set; }
8888

8989
/// <summary>
90-
/// Gets or sets the property value representing column <c>Updated</c>.
90+
/// Gets or sets the <c>Updated</c> value mapped to the <c>Updated</c> column.
9191
/// </summary>
9292
/// <value>
93-
/// The property value representing column <c>Updated</c>.
93+
/// The <c>Updated</c> entity value.
9494
/// </value>
9595
[Column("Updated", TypeName = "datetimeoffset")]
9696
public DateTimeOffset Updated { get; set; }
9797

9898
/// <summary>
99-
/// Gets or sets the property value representing column <c>UpdatedBy</c>.
99+
/// Gets or sets the <c>UpdatedBy</c> value mapped to the <c>UpdatedBy</c> column.
100100
/// </summary>
101101
/// <value>
102-
/// The property value representing column <c>UpdatedBy</c>.
102+
/// The <c>UpdatedBy</c> entity value.
103103
/// </value>
104104
[Column("UpdatedBy", TypeName = "nvarchar(100)")]
105105
public string? UpdatedBy { get; set; }
106106

107107
/// <summary>
108-
/// Gets or sets the property value representing column <c>RowVersion</c>.
108+
/// Gets or sets the <c>RowVersion</c> value mapped to the <c>RowVersion</c> column.
109109
/// </summary>
110110
/// <value>
111-
/// The property value representing column <c>RowVersion</c>.
111+
/// The <c>RowVersion</c> entity value.
112112
/// </value>
113113
[ConcurrencyCheck]
114114
[Column("RowVersion", TypeName = "rowversion")]
@@ -119,10 +119,10 @@ public Priority()
119119

120120
#region Generated Relationships
121121
/// <summary>
122-
/// Gets or sets the navigation collection for entity <see cref="Task" />.
122+
/// Gets or sets the related <see cref="Task" /> entity collection.
123123
/// </summary>
124124
/// <value>
125-
/// The navigation collection for entity <see cref="Task" />.
125+
/// The related <see cref="Task" /> entity collection.
126126
/// </value>
127127
public virtual ICollection<Task> Tasks { get; set; }
128128

0 commit comments

Comments
 (0)