👍 Adjustments for release.

AutumnSky1010 · Jun 15, 2024 · 8817ac2 · 8817ac2
1 parent 8ef4271
commit 8817ac2
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@
 [Wiki](https://github.com/AutumnSky1010/SoundMaker/wiki)
 
 ## ⛰️要件
-.NET 6
+.NET 6 以降
 
 ## ⏬インストール方法
 ### NuGet
@@ -23,6 +23,12 @@
 
 ## 🎶簡単な使い方
 ```CSharp
+using SoundMaker;
+using SoundMaker.Sounds;
+using SoundMaker.Sounds.Score;
+using SoundMaker.Sounds.SoundChannels;
+using SoundMaker.WaveFile;
+
 namespace YourNamespace;
 public static class YourClass
 {
@@ -106,7 +112,7 @@ public static class YourClass
 - Monaural 1ch
 
 ## 🍄作った人のツイッター
-[Twitter](https://twitter.com/DTB_AutumnSky)  
+[Twitter(X)](https://x.com/DTB_AutumnSky)  
 
 ## ©️ライセンス
 MIT License
@@ -120,7 +126,7 @@ You can do The following content with this library.
 [Wiki](https://github.com/AutumnSky1010/SoundMaker/wiki)
 
 ## ⛰️Requirement
-.NET 6
+.NET 6 or later
 
 ## ⏬Installation
 ### NuGet
@@ -129,6 +135,12 @@ You can do The following content with this library.
 
 ## 🎶Usage
 ```CSharp
+using SoundMaker;
+using SoundMaker.Sounds;
+using SoundMaker.Sounds.Score;
+using SoundMaker.Sounds.SoundChannels;
+using SoundMaker.WaveFile;
+
 namespace YourNamespace;
 public static class YourClass
 {
@@ -210,7 +222,7 @@ public static class YourClass
 - Monaural 1ch
 
 ## 🍄Author
-[Twitter](https://twitter.com/DTB_AutumnSky)
+[Twitter(X)](https://x.com/DTB_AutumnSky)
 
 ## ©️License
 SoundMaker is licensed under the MIT License.

diff --git a/src/SoundMaker/ScoreData/SMSC/Error.cs b/src/SoundMaker/ScoreData/SMSC/Error.cs
@@ -1,4 +1,8 @@
 namespace SoundMaker.ScoreData.SMSC;
+/// <summary>
+/// Error of reading SMSC data<br/>
+/// SMSCデータの読み取り結果
+/// </summary>
 public record Error
 {
     internal Error(SMSCReadErrorType type, Token? token)

diff --git a/src/SoundMaker/ScoreData/SMSC/SMSCFormat.cs b/src/SoundMaker/ScoreData/SMSC/SMSCFormat.cs
@@ -10,8 +10,8 @@ public static class SMSCFormat
     /// Reads SMSC data.<br/>
     /// SMSCデータを読み込む。
     /// </summary>
-    /// <param name="data"></param>
-    /// <returns></returns>
+    /// <param name="data">SMSC data. SMSCデータ</param>
+    /// <returns>The read results. 読み取り結果</returns>
     public static SMSCReadResult Read(string data)
     {
         var lexer = new Lexer(data);

diff --git a/src/SoundMaker/ScoreData/SMSC/SMSCReadResult.cs b/src/SoundMaker/ScoreData/SMSC/SMSCReadResult.cs
@@ -57,7 +57,7 @@ public bool TryGetValue(out IReadOnlyList<ISoundComponent> value)
     }
 
     /// <summary>
-    /// Returns the result assuming the reading was successful. If it fails, an empty array is returned. <br/>
+    /// Returns the result assuming the reading was successful. If it fails or empty, an empty array is returned. <br/>
     /// 読み込みに成功した前提で結果を返す。失敗時は空の配列が戻る。
     /// </summary>
     /// <returns>On success: result, On failure: empty array</returns>

diff --git a/src/SoundMaker/SoundMaker.csproj b/src/SoundMaker/SoundMaker.csproj
@@ -11,16 +11,16 @@
     <PackageTags>C#;.NET;game;music;sound;chiptune;audio;wave;wav;</PackageTags>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
-    <Version>2.2.0</Version>
+    <Version>2.3.0</Version>
     <Authors>AutumnSky1010</Authors>
     <Description>You can do The following content with this library.
 
 1. make the sound of chiptune(old game sound)
 2. export sound to a file of wave format.</Description>
     <PackageIcon>SoundMakerIcon.png</PackageIcon>
-    <Copyright>Copyright ©2023 AutumnSky1010</Copyright>
+    <Copyright>Copyright ©2024 AutumnSky1010</Copyright>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    <PackageReleaseNotes>https://github.com/AutumnSky1010/SoundMaker/releases/tag/SoundMaker-ver.2.2.0</PackageReleaseNotes>
+    <PackageReleaseNotes>https://github.com/AutumnSky1010/SoundMaker/releases/tag/SoundMaker-ver.2.3.0</PackageReleaseNotes>
     <PackageProjectUrl>https://github.com/AutumnSky1010/SoundMaker/wiki</PackageProjectUrl>
   </PropertyGroup>