diff options
| author | David Vazgenovich Shakaryan <dvshakaryan@gmail.com> | 2009-07-24 13:28:13 -0700 | 
|---|---|---|
| committer | David Vazgenovich Shakaryan <dvshakaryan@gmail.com> | 2009-07-24 13:28:13 -0700 | 
| commit | ae4ebcb66d4d0c39ac4a29c520ea3bab22b15023 (patch) | |
| tree | e185de936474612d33778b72debb2e168585c9f8 | |
| parent | 5ebda82d1b57733e0960eac5eb74d078b64e7cc5 (diff) | |
| download | ruby-libmpd-ae4ebcb66d4d0c39ac4a29c520ea3bab22b15023.tar.gz ruby-libmpd-ae4ebcb66d4d0c39ac4a29c520ea3bab22b15023.tar.xz | |
Update documentation.
| -rw-r--r-- | libmpd.rb | 6 | ||||
| -rw-r--r-- | libmpd/database.rb | 6 | ||||
| -rw-r--r-- | libmpd/playbackcontrol.rb | 6 | ||||
| -rw-r--r-- | libmpd/playbackoptions.rb | 6 | ||||
| -rw-r--r-- | libmpd/playlist.rb | 6 | ||||
| -rw-r--r-- | libmpd/status.rb | 6 | 
6 files changed, 36 insertions, 0 deletions
| @@ -1,8 +1,13 @@  #!/usr/bin/env ruby  # +#--  # Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>  # Distributed under the terms of the GNU General Public License v3.  # See http://www.gnu.org/licenses/gpl.txt for the full license text. +#++ +# +# *Author*:: David Vazgenovich Shakaryan +# *License*:: GNU General Public License v3  require 'socket'  require 'libmpd/database' @@ -23,6 +28,7 @@ class FalseClass # :nodoc:    end  end +# Class for connecting and communicating with the daemon.  class MPD    include MPDDatabase    include MPDPlaybackControl diff --git a/libmpd/database.rb b/libmpd/database.rb index 20099c8..c71c517 100644 --- a/libmpd/database.rb +++ b/libmpd/database.rb @@ -1,9 +1,15 @@  #!/usr/bin/env ruby  # +#--  # Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>  # Distributed under the terms of the GNU General Public License v3.  # See http://www.gnu.org/licenses/gpl.txt for the full license text. +#++ +# +# *Author*:: David Vazgenovich Shakaryan +# *License*:: GNU General Public License v3 +# Collection of methods related to the database.  module MPDDatabase    # Counts the number of songs in the database where _field_ is _value_, as    # well as their total playtime. diff --git a/libmpd/playbackcontrol.rb b/libmpd/playbackcontrol.rb index d37ed49..de5643d 100644 --- a/libmpd/playbackcontrol.rb +++ b/libmpd/playbackcontrol.rb @@ -1,9 +1,15 @@  #!/usr/bin/env ruby  # +#--  # Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>  # Distributed under the terms of the GNU General Public License v3.  # See http://www.gnu.org/licenses/gpl.txt for the full license text. +#++ +# +# *Author*:: David Vazgenovich Shakaryan +# *License*:: GNU General Public License v3 +# Collection of methods related to playback control.  module MPDPlaybackControl    # Begins playing the playlist. If argument is supplied, begin at specified    # song position. diff --git a/libmpd/playbackoptions.rb b/libmpd/playbackoptions.rb index fd83d9e..3e6ad1e 100644 --- a/libmpd/playbackoptions.rb +++ b/libmpd/playbackoptions.rb @@ -1,9 +1,15 @@  #!/usr/bin/env ruby  # +#--  # Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>  # Distributed under the terms of the GNU General Public License v3.  # See http://www.gnu.org/licenses/gpl.txt for the full license text. +#++ +# +# *Author*:: David Vazgenovich Shakaryan +# *License*:: GNU General Public License v3 +# Collection of methods related to playback options.  module MPDPlaybackOptions    # Sets consume state.    # When consume is activated, each song played is removed from the playlist. diff --git a/libmpd/playlist.rb b/libmpd/playlist.rb index d05141f..1b591c6 100644 --- a/libmpd/playlist.rb +++ b/libmpd/playlist.rb @@ -1,9 +1,15 @@  #!/usr/bin/env ruby  # +#--  # Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>  # Distributed under the terms of the GNU General Public License v3.  # See http://www.gnu.org/licenses/gpl.txt for the full license text. +#++ +# +# *Author*:: David Vazgenovich Shakaryan +# *License*:: GNU General Public License v3 +# Collection of methods related to the playlist.  module MPDPlaylist    # Adds the specified file to the playlist. (Directories add recursively.)    def add uri diff --git a/libmpd/status.rb b/libmpd/status.rb index de00e07..639edb4 100644 --- a/libmpd/status.rb +++ b/libmpd/status.rb @@ -1,9 +1,15 @@  #!/usr/bin/env ruby  # +#--  # Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>  # Distributed under the terms of the GNU General Public License v3.  # See http://www.gnu.org/licenses/gpl.txt for the full license text. +#++ +# +# *Author*:: David Vazgenovich Shakaryan +# *License*:: GNU General Public License v3 +# Collection of methods related to the status.  module MPDStatus    # Returns a Hash containing information about the current song.    def currentsong | 
