Permalink
Browse files

improving documentation through yard tags

  • Loading branch information...
1 parent e7e5fb3 commit 258987e21e82009dda4905a1c258ac0b312fb0bd Macario Ortega committed Mar 21, 2011
Showing with 13 additions and 16 deletions.
  1. +13 −16 lib/scruby/server.rb
View
@@ -29,22 +29,19 @@ class Server
# The server is a Ruby representation of scsynth which can be a local binary or a remote
# server already running.
# Server class keeps an array with all the instantiated servers
- #
- # Options:
- # +host+:
- # defaults to 'localhost'
- # +port+:
- # TCP port defaults to 57111
- # +control_buses+
- # Number of buses for routing control data defaults to 4096, indices start at 0.
- # +audio_buses+
- # Number of audio Bus channels for hardware output and input and internal routing, defaults to 128
- # +audio_outputs+
- # Reserved +buses+ for hardware output, indices available are 0 to +audio_outputs+ - 1 defaults to 8.
- # +audio_inputs+
- # Reserved +buses+ for hardware input, +audio_outputs+ to (+audio_outputs+ + +audio_inputs+ - 1), defaults to 8.
- # +buffers+
- # Number of available sample buffers defaults to 1024
+ #
+ # For more info
+ # $ man scsynth
+ #
+ # @param [Hash] opts the options to create a message with.
+ # @option opts [String] :host ('localhost') SuperCollider Server address
+ # @option opts [Fixnum] :port (57111) TCP port
+ # @option opts [Fixnum] :control_buses (4096) Number of buses for routing control data, indices start at 0
+ # @option opts [Fixnum] :audio_buses (8) Number of audio Bus channels for hardware output and input and internal routing
+ # @option opts [Fixnum] :audio_outputs (8) Reserved buses for hardware output, indices start at 0
+ # @option opts [Fixnum] :audio_inputs (8) Reserved buses for hardware input, indices starting from the number of audio outputs
+ # @option opts [Fixnum] :buffers (1024) Number of available sample buffers
+ #
def initialize opts = {}
@opts = DEFAULTS.dup.merge opts
@buffers = []

0 comments on commit 258987e

Please sign in to comment.