Make RDoc-friendly: comments, private methods.

1 files changed, 27 insertions, 0 deletions

diff --git a/mpdlib.rb b/mpdlib.rb
index 97ade60..6b9ac69 100644
--- a/mpdlib.rb
+++ b/mpdlib.rb
@@ -7,11 +7,15 @@
 require 'socket'
 
 class MPD
+  # Initialise an MPD object with the specified host and port.
+  #
+  # The default host is "localhost" and the default port is 6600.
   def initialize host='localhost', port=6600
     @host = host
     @port = port
   end
 
+  # Connect to the server.
   def connect
     # Connect to MPD and return response.
     @socket = TCPSocket.new @host, @port
@@ -51,18 +55,23 @@ class MPD
     return hash
   end
 
+  # Returns a Hash containing information about the current song.
   def currentsong
     return generate_hash send_request 'currentsong'
   end
 
+  # Returns a Hash containing the current status.
   def status
     return generate_hash send_request 'status'
   end
 
+  # Returns a Hash containing statistics.
   def stats
     return generate_hash send_request 'stats'
   end
 
+  # Begins playing the playlist. If argument is supplied, begin at specified
+  # position.
   def play songpos=false
     command = 'play'
     command << ' ' + songpos.to_s if songpos
@@ -70,34 +79,42 @@ class MPD
     return send_request command
   end
 
+  # Toggles pause. (1 = pause, 0 = play)
   def pause pause
     return send_request 'pause ' + pause.to_s
   end
 
+  # Stops playing.
   def stop
     return send_request 'stop'
   end
 
+  # Plays next song in the playlist.
   def next
     return send_request 'next'
   end
 
+  # Plays previous song in the playlist.
   def previous
     return send_request 'previous'
   end
 
+  # Seeks to the given position of the given song.
   def seek songpos, time
     return send_request 'seek %s %s' % [songpos, time]
   end
 
+  # Adds the specified file to the playlist. (Directories add recursively.)
   def add uri
     return send_request 'add "%s"' % uri
   end
 
+  # Deletes a song from the playlist.
   def delete songpos
     return send_request 'delete ' + songpos.to_s
   end
 
+  # Clears the playlist.
   def clear
     return send_request 'clear'
   end
@@ -110,16 +127,26 @@ class MPD
     return songs
   end
 
+  # Returns an Array composed of Hashes containing information about the songs
+  # in the playlist.
+  #
   # Not yet complete.
   def playlistinfo
     return split_and_hash send_request 'playlistinfo'
   end
 
+  # Find all songs in database with an exact match.
   def find type, what
     return split_and_hash send_request 'find %s "%s"' % [type, what]
   end
 
+  # Searches the database.
   def search type, what
     return split_and_hash send_request 'search %s "%s"' % [type, what]
   end
+
+  private :generate_hash
+  private :get_response
+  private :send_request
+  private :split_and_hash
 end