From 90d9d729208cbbf3615b3fb3b9b8e64bd630d5f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Divi=C5=A1?= Date: Fri, 3 Nov 2023 22:31:34 +0100 Subject: [PATCH 1/3] fix: add xml docs and readme to packages --- .../DarkMusicConcepts.Units.csproj | 9 ++++----- src/DarkMusicConcepts/DarkMusicConcepts.csproj | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj b/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj index 7ceeb8b..e5c9f77 100644 --- a/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj +++ b/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj @@ -8,14 +8,15 @@ false + True Divis.DarkMusicConcepts.Units - 0.0.0-dev michaldivis Michal Diviš Dark Music Concepts Units Western music units. https://github.com/michaldivis/dark-music-concepts icon.png + README.md https://github.com/michaldivis/dark-music-concepts music, music theory, music-library, units en @@ -23,10 +24,8 @@ - - True - \ - + + diff --git a/src/DarkMusicConcepts/DarkMusicConcepts.csproj b/src/DarkMusicConcepts/DarkMusicConcepts.csproj index b312a28..706e36a 100644 --- a/src/DarkMusicConcepts/DarkMusicConcepts.csproj +++ b/src/DarkMusicConcepts/DarkMusicConcepts.csproj @@ -8,14 +8,15 @@ false + True Divis.DarkMusicConcepts - 0.0.0-dev michaldivis Michal Diviš Dark Music Concepts A code model for western music concepts. https://github.com/michaldivis/dark-music-concepts icon.png + README.md https://github.com/michaldivis/dark-music-concepts music, music theory, music-library en @@ -23,10 +24,8 @@ - - True - \ - + + From 989a945da275aae28357480b8deecf220434a62c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Divi=C5=A1?= Date: Fri, 3 Nov 2023 22:34:01 +0100 Subject: [PATCH 2/3] fix: disable CS1591 --- src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj | 2 ++ src/DarkMusicConcepts/DarkMusicConcepts.csproj | 2 ++ 2 files changed, 4 insertions(+) diff --git a/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj b/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj index e5c9f77..02403f2 100644 --- a/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj +++ b/src/DarkMusicConcepts.Units/DarkMusicConcepts.Units.csproj @@ -9,6 +9,8 @@ false True + + $(NoWarn);CS1591 Divis.DarkMusicConcepts.Units michaldivis Michal Diviš diff --git a/src/DarkMusicConcepts/DarkMusicConcepts.csproj b/src/DarkMusicConcepts/DarkMusicConcepts.csproj index 706e36a..e14142b 100644 --- a/src/DarkMusicConcepts/DarkMusicConcepts.csproj +++ b/src/DarkMusicConcepts/DarkMusicConcepts.csproj @@ -9,6 +9,8 @@ false True + + $(NoWarn);CS1591 Divis.DarkMusicConcepts michaldivis Michal Diviš From 47c500a662022bb708a392d833c779a1dfb17324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Divi=C5=A1?= Date: Fri, 3 Nov 2023 22:38:58 +0100 Subject: [PATCH 3/3] fix: resolve some XML errors --- src/DarkMusicConcepts.Units/Time.cs | 2 +- src/DarkMusicConcepts/Chords/Chord.cs | 1 + src/DarkMusicConcepts/Chords/ChordProgressions.cs | 2 +- src/DarkMusicConcepts/Scales/Scale.cs | 2 ++ 4 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/DarkMusicConcepts.Units/Time.cs b/src/DarkMusicConcepts.Units/Time.cs index cb685e1..074498a 100644 --- a/src/DarkMusicConcepts.Units/Time.cs +++ b/src/DarkMusicConcepts.Units/Time.cs @@ -1,6 +1,6 @@ namespace DarkMusicConcepts; /// -/// Representation of musical time, the () is stored in MIDI ticks +/// Representation of musical time, the value is stored in MIDI ticks /// public class Time : Unit { diff --git a/src/DarkMusicConcepts/Chords/Chord.cs b/src/DarkMusicConcepts/Chords/Chord.cs index 488d0bf..f6ed50c 100644 --- 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); /// /// Scale + /// Root pitch /// Octave to start the root note in /// The steps to find the notes (each step is relative to the previous one) /// A chord created from the scale, root pitch and steps diff --git a/src/DarkMusicConcepts/Chords/ChordProgressions.cs b/src/DarkMusicConcepts/Chords/ChordProgressions.cs index a13b805..bbbeec4 100644 --- a/src/DarkMusicConcepts/Chords/ChordProgressions.cs +++ b/src/DarkMusicConcepts/Chords/ChordProgressions.cs @@ -7,7 +7,7 @@ public static class ChordProgressions { public static class Pop { - //// + /// ///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. /// public static ChordProgression I_IV_V_IV { get; } = new(ScaleDegree.I, ScaleDegree.IV, ScaleDegree.V, ScaleDegree.IV); diff --git a/src/DarkMusicConcepts/Scales/Scale.cs b/src/DarkMusicConcepts/Scales/Scale.cs index 49b9cbd..5364c7b 100644 --- a/src/DarkMusicConcepts/Scales/Scale.cs +++ b/src/DarkMusicConcepts/Scales/Scale.cs @@ -11,6 +11,8 @@ public class Scale /// /// Create a scale from notes /// + /// The root pitch + /// The scale formula /// Notes to create the scale from /// A created scale ///