Added docs to the Local-API

JohnnyCrazy · JohnnyCrazy · commit 5c3c354c26c7 · 2015-10-15T14:58:23.000+02:00
diff --git a/SpotifyAPI/Local/SpotifyLocalAPI.cs b/SpotifyAPI/Local/SpotifyLocalAPI.cs
@@ -139,11 +139,18 @@ public Boolean Connect()
             return _rh.Init();
         }
 
+        /// <summary>
+        /// Update and returns the new StatusResponse from the Spotify-Player
+        /// </summary>
+        /// <returns>An up-to-date StatusResponse</returns>
         public StatusResponse GetStatus()
         {
             return _rh.GetNewStatus();
         }
 
+        /// <summary>
+        /// Mutes Spotify (Requires nircmd.dll)
+        /// </summary>
         public void Mute()
         {
             if (File.Exists("nircmd.dll"))

Original file line number	Diff line number	Diff line change
`@@ -139,11 +139,18 @@ public Boolean Connect()`
`139`	`139`	`return _rh.Init();`
`140`	`140`	`}`
`141`	`141`
	`142`	`+ /// <summary>`
	`143`	`+ /// Update and returns the new StatusResponse from the Spotify-Player`
	`144`	`+ /// </summary>`
	`145`	`+ /// <returns>An up-to-date StatusResponse</returns>`
`142`	`146`	`public StatusResponse GetStatus()`
`143`	`147`	`{`
`144`	`148`	`return _rh.GetNewStatus();`
`145`	`149`	`}`
`146`	`150`
	`151`	`+ /// <summary>`
	`152`	`+ /// Mutes Spotify (Requires nircmd.dll)`
	`153`	`+ /// </summary>`
`147`	`154`	`public void Mute()`
`148`	`155`	`{`
`149`	`156`	`if (File.Exists("nircmd.dll"))`