Skip to content

Commit 9169193

Browse files
Fix some warnings
1 parent db04319 commit 9169193

File tree

13 files changed

+89
-13
lines changed

13 files changed

+89
-13
lines changed

SysML2.NET.CodeGenerator/Templates/Uml/Partials/core-json-dto-deserializer-uml-partial-template.hbs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,5 +113,4 @@
113113
else
114114
{
115115
logger.LogDebug("the {{ property.Name }} Json property was not found in the {{ classContext.Name }}: {Id}", dtoInstance.Id);
116-
}
117-
116+
}

SysML2.NET/PIM/ChangeType.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,24 @@
2020

2121
namespace SysML2.NET.PIM
2222
{
23+
/// <summary>
24+
/// Defines changes type
25+
/// </summary>
2326
public enum ChangeType
2427
{
28+
/// <summary>
29+
/// To be used in case of creation
30+
/// </summary>
2531
CREATED,
2632

33+
/// <summary>
34+
/// To be used in case of deletion
35+
/// </summary>
2736
DELETED,
2837

38+
/// <summary>
39+
/// To be used in case of update
40+
/// </summary>
2941
UPDATED,
3042
}
3143
}

SysML2.NET/PIM/DTO/Commit.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace SysML2.NET.PIM.DTO
3131
/// a <see cref="Project"/>. A <see cref="Project"/> has 0 or more <see cref="Commit"/>s
3232
/// </summary>
3333
/// <remarks>
34-
/// <see cref="Commit"/>s are immutable. For a given <see cref="Commit"/> record, the value of <see cref="Commit.Change"/>
34+
/// <see cref="Commit"/>s are immutable. For a given <see cref="Commit"/> record, the value of <see cref="Commit.Create"/>
3535
/// cannot be modified after a <see cref="Commit"/> has been created. If a modification is required, a new <see cref="Commit"/>
3636
/// record can be created with a different value of <see cref="Commit.Change"/>.
3737
/// <see cref="Commit"/>s are not destructible1. A <see cref="Commit"/> record cannot be deleted during normal

SysML2.NET/PIM/DTO/CommitReference.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ namespace SysML2.NET.PIM.DTO
2222
{
2323
using System;
2424

25+
using SysML2.NET.Common;
26+
2527
/// <summary>
2628
/// An abstract subclass of <see cref="Record"/> that references a specific <see cref="Commit"/> (Commit Reference.referencedCommit). Project.commit is the set of all the Commit records for a given Project.
2729
/// <see cref="Project.CommitRefererence"/> identifies specific <see cref="Commit"/> records in a <see cref="Project"/> that provide the context for navigating the

SysML2.NET/PIM/DTO/PrimitiveConstraint.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace SysML2.NET.PIM.DTO
2424

2525
/// <summary>
2626
/// a subtype of Constraint that represents simple conditions that be modeled using the
27-
/// property-operator -value tuple. e.g. mass <= 4 kg, or type instanceOf Generalization
27+
/// property-operator -value tuple. e.g. mass &lt;= 4 kg, or type instanceOf Generalization
2828
/// </summary>
2929
public class PrimitiveConstraint
3030
{

SysML2.NET/PIM/DTO/Project.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ namespace SysML2.NET.PIM.DTO
3131
/// </summary>
3232
public class Project : Record
3333
{
34+
/// <summary>
35+
/// Gets or sets the collection of <see cref="Commit" />
36+
/// </summary>
3437
public List<Guid> Commits { get; set; } = new List<Guid>();
3538

3639
/// <summary>
@@ -41,13 +44,16 @@ public class Project : Record
4144
/// <summary>
4245
/// Gets or sets the human readable name
4346
/// </summary>
44-
public string Name { get; set; }
47+
public new string Name { get; set; }
4548

4649
/// <summary>
4750
/// Gets or sets the default <see cref="Branch"/> in the <see cref="Project"/> which is a subset of <see cref="Branch"/>
4851
/// </summary>
4952
public Guid DefaultBranch { get; set; }
5053

54+
/// <summary>
55+
/// Gets or sets the collection of <see cref="Query" />
56+
/// </summary>
5157
public List<Guid> Queries { get; set; } = [];
5258
}
5359
}

SysML2.NET/PIM/Direction.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,24 @@
2020

2121
namespace SysML2.NET.PIM
2222
{
23+
/// <summary>
24+
/// Defines possible direction
25+
/// </summary>
2326
public enum Direction
2427
{
28+
/// <summary>
29+
/// At the same time in and out
30+
/// </summary>
2531
both,
2632

33+
/// <summary>
34+
/// To be use for on an income direction
35+
/// </summary>
2736
@in,
2837

38+
/// <summary>
39+
/// To be use for on an outcome direction
40+
/// </summary>
2941
@out
3042
}
3143
}

SysML2.NET/PIM/JoinOperator.cs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,21 @@
2020

2121
namespace SysML2.NET.PIM
2222
{
23+
using SysML2.NET.PIM.DTO;
24+
2325
/// <summary>
24-
/// Enumeration whose literals are logical operator for composing <see cref="Constraints"/>
26+
/// Enumeration whose literals are logical operator for composing <see cref="Constraint"/>
2527
/// </summary>
2628
public enum JoinOperator
2729
{
30+
/// <summary>
31+
/// The logical AND join operator
32+
/// </summary>
2833
AND,
2934

35+
/// <summary>
36+
/// The logical OR join operator
37+
/// </summary>
3038
OR
3139
}
3240
}

SysML2.NET/PIM/Operator.cs

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,39 @@ namespace SysML2.NET.PIM
2525
/// </summary>
2626
public enum Operator
2727
{
28+
/// <summary>
29+
/// To assert that it is an instance of a specific type
30+
/// </summary>
2831
instanceOf,
2932

33+
/// <summary>
34+
/// To assert that it is equal to
35+
/// </summary>
3036
equalto,
3137

38+
/// <summary>
39+
/// To assert that it is less than
40+
/// </summary>
3241
lessthan,
3342

34-
lesthanorequalto,
43+
/// <summary>
44+
/// To assert that it is less than or equal to
45+
/// </summary>
46+
lessthanorequalto,
3547

48+
/// <summary>
49+
/// To assert that it is greater than
50+
/// </summary>
3651
greaterthan,
3752

53+
/// <summary>
54+
/// To assert that it is greater than or equal to
55+
/// </summary>
3856
greaterthanorequalto,
3957

58+
/// <summary>
59+
/// To assert that it is in
60+
/// </summary>
4061
@in
4162
}
4263
}

SysML2.NET/PIM/POCO/PrimitiveConstraint.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace SysML2.NET.PIM.POCO
2424

2525
/// <summary>
2626
/// a subtype of Constraint that represents simple conditions that be modeled using the
27-
/// property-operator -value tuple. e.g. mass <= 4 kg, or type instanceOf Generalization
27+
/// property-operator -value tuple. e.g. mass &lt;= 4 kg, or type instanceOf Generalization
2828
/// </summary>
2929
public class PrimitiveConstraint : Constraint
3030
{

0 commit comments

Comments
 (0)