Skip to content

Commit

Permalink
fix comment text to be preceded by single whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
smdn committed Apr 2, 2024
1 parent f9f9911 commit ee47294
Show file tree
Hide file tree
Showing 9 changed files with 182 additions and 182 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ byte classCode

var properties = new List<EchonetPropertySpecification>(capacity: MaxNumberOfProperty);

//スーパークラスのプロパティを列挙
// スーパークラスのプロパティを列挙
using (var stream = GetSpecificationMasterDataStream($"{classGroupSpec.SuperClassName}.json")) {
var superClassProperties = JsonSerializer.Deserialize<PropertyMaster>(stream) ?? throw new InvalidOperationException($"{nameof(PropertyMaster)} can not be null");
properties.AddRange(superClassProperties.Properties);
Expand All @@ -163,7 +163,7 @@ byte classCode
var classGroupDirectoryName = $"0x{classGroupSpec.Code:X2}-{classGroupSpec.PropertyName}";
var classFileName = $"0x{classSpec.Code:X2}-{classSpec.PropertyName}.json";

//クラスのプロパティを列挙
// クラスのプロパティを列挙
using (var stream = GetSpecificationMasterDataStream(classGroupDirectoryName, classFileName)) {
if (stream is not null) {
var classProperties = JsonSerializer.Deserialize<PropertyMaster>(stream) ?? throw new InvalidOperationException($"{nameof(PropertyMaster)} can not be null");
Expand Down
12 changes: 6 additions & 6 deletions src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/EHD1.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
namespace Smdn.Net.EchonetLite.Protocol;

public enum EHD1 : byte {
//図 3-2 EHD1 詳細規定
//プロトコル種別
//1* * * :従来のECHONET規格
//0001:ECHONET Lite規格
// 図 3-2 EHD1 詳細規定
// プロトコル種別
// 1* * * :従来のECHONET規格
// 0001:ECHONET Lite規格
EchonetLite = 0x10,
//0000:使用不可
//その他:future reserved
// 0000:使用不可
// その他:future reserved
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Smdn.Net.EchonetLite.Protocol;

public enum EHD2 : byte {
//図 3-3 EHD2 詳細規定
// 図 3-3 EHD2 詳細規定
/// <summary>
/// 形式1
/// </summary>
Expand All @@ -13,6 +13,6 @@ public enum EHD2 : byte {
/// 形式2
/// </summary>
Type2 = 0x82,
//その他:future reserved
//ただし、b7=1固定
// その他:future reserved
// ただし、b7=1固定
}
52 changes: 26 additions & 26 deletions src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/ESV.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,48 @@
namespace Smdn.Net.EchonetLite.Protocol;

public enum ESV : byte {
//表 3-9 要求用 ESV コード一覧表
///<summary>0x60 プロパティ値書き込み要求(応答不要) SetI 一斉同報可</summary>
// 表 3-9 要求用 ESV コード一覧表
/// <summary>0x60 プロパティ値書き込み要求(応答不要) SetI 一斉同報可</summary>
SetI = 0x60,
///<summary>0x61 プロパティ値書き込み要求(応答要) SetC </summary>
/// <summary>0x61 プロパティ値書き込み要求(応答要) SetC </summary>
SetC = 0x61,
///<summary>0x62 プロパティ値読み出し要求 Get 一斉同報可</summary>
/// <summary>0x62 プロパティ値読み出し要求 Get 一斉同報可</summary>
Get = 0x62,
///<summary>0x63 プロパティ値通知要求 INF_REQ 一斉同報可</summary>
/// <summary>0x63 プロパティ値通知要求 INF_REQ 一斉同報可</summary>
InfRequest = 0x63,
//0x64-0x6D for future reserved,
///<summary>0x6E プロパティ値書き込み・読み出し要求 SetGet 一斉同報可</summary>
// 0x64-0x6D for future reserved,
/// <summary>0x6E プロパティ値書き込み・読み出し要求 SetGet 一斉同報可</summary>
SetGet = 0x6E,
//0x6F for future reserved,
// 0x6F for future reserved,

//表 3-10 応答・通知用 ESV コード一覧表
///<summary>0x71 プロパティ値書き込み応答 Set_Res ESV=0x61 の応答、個別応答</summary>
// 表 3-10 応答・通知用 ESV コード一覧表
/// <summary>0x71 プロパティ値書き込み応答 Set_Res ESV=0x61 の応答、個別応答</summary>
SetResponse = 0x71,
///<summary>0x72 プロパティ値読み出し応答 Get_Res ESV=0x62 の応答、個別応答</summary>
/// <summary>0x72 プロパティ値読み出し応答 Get_Res ESV=0x62 の応答、個別応答</summary>
GetResponse = 0x72,
///<summary>0x73 プロパティ値通知 INF *1個別通知、一斉同報通知共に可</summary>
/// <summary>0x73 プロパティ値通知 INF *1個別通知、一斉同報通知共に可</summary>
Inf = 0x73,
///<summary>0x74 プロパティ値通知(応答要) INFC 個別通知</summary>
/// <summary>0x74 プロパティ値通知(応答要) INFC 個別通知</summary>
InfC = 0x74,
//0x75-0x79 for future reserved,
///<summary>0x7A プロパティ値通知応答 INFC_Res ESV=0x74 の応答、個別応答</summary>
// 0x75-0x79 for future reserved,
/// <summary>0x7A プロパティ値通知応答 INFC_Res ESV=0x74 の応答、個別応答</summary>
InfCResponse = 0x7A,
//0x7B-0x7D for future reserved,
///<summary>0x7E プロパティ値書き込み・読み出し応答 SetGet_Res ESV=0x6E の応答、個別応答</summary>
// 0x7B-0x7D for future reserved,
/// <summary>0x7E プロパティ値書き込み・読み出し応答 SetGet_Res ESV=0x6E の応答、個別応答</summary>
SetGetResponse = 0x7E,
//0x7F for future reserved,
// 0x7F for future reserved,

//表 3-11 不可応答用 ESV コード一覧表
///<summary>0x50 プロパティ値書き込み要求不可応答 SetI_SNA ESV=0x60 の不可応答、個別応答</summary>
// 表 3-11 不可応答用 ESV コード一覧表
/// <summary>0x50 プロパティ値書き込み要求不可応答 SetI_SNA ESV=0x60 の不可応答、個別応答</summary>
SetIServiceNotAvailable = 0x50,
///<summary>0x51 プロパティ値書き込み要求不可応答 SetC_SNA ESV=0x61 の不可応答、個別応答</summary>
/// <summary>0x51 プロパティ値書き込み要求不可応答 SetC_SNA ESV=0x61 の不可応答、個別応答</summary>
SetCServiceNotAvailable = 0x51,
///<summary>0x52 プロパティ値読み出し不可応答 Get_SNA ESV=0x62 の不可応答、個別応答</summary>
/// <summary>0x52 プロパティ値読み出し不可応答 Get_SNA ESV=0x62 の不可応答、個別応答</summary>
GetServiceNotAvailable = 0x52,
///<summary>0x53 プロパティ値通知不可応答 INF_SNA ESV=0x63 の不可応答、個別応答</summary>
/// <summary>0x53 プロパティ値通知不可応答 INF_SNA ESV=0x63 の不可応答、個別応答</summary>
InfServiceNotAvailable = 0x53,
//0x54-0x5D for future reserved,
///<summary>0x5E プロパティ値書き込み・読み出し不可応答 SetGet_SNA ESV=0x6E の不可応答、個別応答</summary>
// 0x54-0x5D for future reserved,
/// <summary>0x5E プロパティ値書き込み・読み出し不可応答 SetGet_SNA ESV=0x6E の不可応答、個別応答</summary>
SetGetServiceNotAvailable = 0x5E,
//0x5F for future reserved
// 0x5F for future reserved
}
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public static void SerializeEchonetLiteFrameFormat1(
// EDTのバイト数(1B)
// プロパティ値データ(PDCで指定)

//4.2.3.4 プロパティ値書き込み読み出しサービス[0x6E,0x7E,0x5E]
// 4.2.3.4 プロパティ値書き込み読み出しサービス[0x6E,0x7E,0x5E]
// OPCSet 処理プロパティ数(1B)
// ECHONET Liteプロパティ(1B)
// EDTのバイト数(1B)
Expand Down Expand Up @@ -120,11 +120,11 @@ public static bool TryDeserialize(ReadOnlySpan<byte> bytes, out Frame frame)
{
frame = default;

//ECHONETLiteフレームとしての最小長に満たない
// ECHONETLiteフレームとしての最小長に満たない
if (bytes.Length < 4)
return false;

//EHD1が0x1*(0001***)以外の場合、ECHONETLiteフレームではない
// EHD1が0x1*(0001***)以外の場合、ECHONETLiteフレームではない
if ((bytes[0] & 0xF0) != (byte)EHD1.EchonetLite)
return false;

Expand Down Expand Up @@ -183,7 +183,7 @@ private static bool TryReadEDataType1(ReadOnlySpan<byte> bytes, [NotNullWhen(tru
bytes = bytes.Slice(7);

if (IsESVWriteOrReadService(esv)) {
//4.2.3.4 プロパティ値書き込み読み出しサービス[0x6E,0x7E,0x5E]
// 4.2.3.4 プロパティ値書き込み読み出しサービス[0x6E,0x7E,0x5E]
// OPCSet 処理プロパティ数(1B)
// ECHONET Liteプロパティ(1B)
// EDTのバイト数(1B)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ out int bytesWritten
if (instanceList is null)
return false;

//1 バイト目:通報インスタンス数
// 1 バイト目:通報インスタンス数
if (destination.Length < 1)
return false;

Expand All @@ -44,7 +44,7 @@ out int bytesWritten
bytesWritten++;
destination = destination.Slice(1);

//2~253 バイト目:ECHONET オブジェクトコード(EOJ3 バイト)を列挙。
// 2~253 バイト目:ECHONET オブジェクトコード(EOJ3 バイト)を列挙。
var numberOfInstances = 0;

foreach (var instance in instanceList) {
Expand Down Expand Up @@ -88,7 +88,7 @@ public static bool TryDeserializeInstanceListNotification(
{
instanceList = default;

//1 バイト目:通報インスタンス数
// 1 バイト目:通報インスタンス数
if (content.Length < 1)
return false;

Expand All @@ -97,7 +97,7 @@ public static bool TryDeserializeInstanceListNotification(

content = content.Slice(1);

//2~253 バイト目:ECHONET オブジェクトコード(EOJ3 バイト)を列挙。
// 2~253 バイト目:ECHONET オブジェクトコード(EOJ3 バイト)を列挙。
for (var i = 0; i < numberOfInstance; i++) {
if (content.Length < 3)
return false;
Expand Down Expand Up @@ -147,7 +147,7 @@ public static bool TryDeserializePropertyMap(
{
propertyMap = default;

//1 バイト目:プロパティの数。バイナリ表示。
// 1 バイト目:プロパティの数。バイナリ表示。
if (content.Length < 1)
return false;

Expand Down
Loading

0 comments on commit ee47294

Please sign in to comment.