fix: add xml docs and readme to packages (#24)

michaldivis · Nov 3, 2023 · c111eb9 · c111eb9
1 parent f730371
commit c111eb9
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 12 deletions.
diff --git a/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj b/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj
@@ -8,25 +8,26 @@
 
 	<PropertyGroup>
 		<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+		<GenerateDocumentationFile>True</GenerateDocumentationFile>
+		<!-- Disable the compiler warnings not documented members-->
+		<NoWarn>$(NoWarn);CS1591</NoWarn>
 		<PackageId>Divis.DarkMusicConcepts.Units</PackageId>
-		<Version>0.0.0-dev</Version>
 		<Authors>michaldivis</Authors>
 		<Company>Michal Diviš</Company>
 		<Product>Dark Music Concepts Units</Product>
 		<Description>Western music units.</Description>
 		<PackageProjectUrl>https://github.com/michaldivis/dark-music-concepts</PackageProjectUrl>
 		<PackageIcon>icon.png</PackageIcon>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<RepositoryUrl>https://github.com/michaldivis/dark-music-concepts</RepositoryUrl>
 		<PackageTags>music, music theory, music-library, units</PackageTags>
 		<NeutralLanguage>en</NeutralLanguage>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<None Include="..\..\assets\icon.png">
-			<Pack>True</Pack>
-			<PackagePath>\</PackagePath>
-		</None>
+		<None Include="..\..\assets\icon.png" Pack="true" PackagePath="\"/>
+		<None Include="..\..\README.md" Pack="true" PackagePath="\"/>
 	</ItemGroup>
 
 </Project>
diff --git a/src/DarkMusicConcepts.Units/Time.cs b/src/DarkMusicConcepts.Units/Time.cs
@@ -1,6 +1,6 @@
 namespace DarkMusicConcepts;
 /// <summary>
-/// Representation of musical time, the (<see cref="Value"/>) is stored in MIDI ticks
+/// Representation of musical time, the value is stored in MIDI ticks
 /// </summary>
 public class Time : Unit<long, Time>
 {

diff --git a/src/DarkMusicConcepts/Chords/Chord.cs b/src/DarkMusicConcepts/Chords/Chord.cs
@@ -141,6 +141,7 @@ public static Chord Create(Scale scale, Octave octave, ScaleDegree scaleDegree)
     /// var chord = Chord.Create(scale, scale.I, Octave.OneLine, ScaleStep.II, ScaleStep.II);</code>
     /// </summary>
     /// <param name="scale">Scale</param>
+    /// <param name="rootPitch">Root pitch</param>
     /// <param name="octave">Octave to start the root note in</param>
     /// <param name="scaleSteps">The steps to find the notes (each step is relative to the previous one)</param>
     /// <returns>A chord created from the scale, root pitch and steps</returns>

diff --git a/src/DarkMusicConcepts/Chords/ChordProgressions.cs b/src/DarkMusicConcepts/Chords/ChordProgressions.cs
@@ -7,7 +7,7 @@ public static class ChordProgressions
 {
     public static class Pop
     {
-        //// <summary>
+        /// <summary>
         ///This chord progression uses the tonic, subdominant, dominant, and subdominant chords in that order. It is a common and versatile progression, and it can be used in many different keys and styles of pop music. For example, in the key of C major, the progression would be C-F-G-F.
         ///</summary>
         public static ChordProgression I_IV_V_IV { get; } = new(ScaleDegree.I, ScaleDegree.IV, ScaleDegree.V, ScaleDegree.IV);

diff --git a/src/DarkMusicConcepts/DarkMusicConcepts.csproj b/src/DarkMusicConcepts/DarkMusicConcepts.csproj
@@ -8,25 +8,26 @@
 
 	<PropertyGroup>
 		<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+		<GenerateDocumentationFile>True</GenerateDocumentationFile>
+		<!-- Disable the compiler warnings not documented members-->
+		<NoWarn>$(NoWarn);CS1591</NoWarn>
 		<PackageId>Divis.DarkMusicConcepts</PackageId>
-		<Version>0.0.0-dev</Version>
 		<Authors>michaldivis</Authors>
 		<Company>Michal Diviš</Company>
 		<Product>Dark Music Concepts</Product>
 		<Description>A code model for western music concepts.</Description>
 		<PackageProjectUrl>https://github.com/michaldivis/dark-music-concepts</PackageProjectUrl>
 		<PackageIcon>icon.png</PackageIcon>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<RepositoryUrl>https://github.com/michaldivis/dark-music-concepts</RepositoryUrl>
 		<PackageTags>music, music theory, music-library</PackageTags>
 		<NeutralLanguage>en</NeutralLanguage>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 	</PropertyGroup>
 
   <ItemGroup>
-    <None Include="..\..\assets\icon.png">
-      <Pack>True</Pack>
-      <PackagePath>\</PackagePath>
-    </None>
+    <None Include="..\..\assets\icon.png" Pack="true" PackagePath="\"/>
+	<None Include="..\..\README.md" Pack="true" PackagePath="\"/>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/DarkMusicConcepts/Scales/Scale.cs b/src/DarkMusicConcepts/Scales/Scale.cs
@@ -11,6 +11,8 @@ public class Scale
     /// <summary>
     /// Create a scale from notes
     /// </summary>
+    /// <param name="root">The root pitch</param>
+    /// <param name="formula">The scale formula</param>
     /// <param name="pitches">Notes to create the scale from</param>
     /// <returns>A created scale</returns>
     /// <exception cref="ArgumentNullException"></exception>