Permalink
Browse files

Tighten up source documentation

  • Loading branch information...
1 parent fee17ac commit 3ff5ec6b3301fc21d47bac343621d46864d983a3 @njonsson committed Jan 12, 2013
Showing with 10 additions and 6 deletions.
  1. +2 −0 lib/cape/capistrano.rb
  2. +2 −2 lib/cape/dsl.rb
  3. +5 −3 lib/cape/rake.rb
  4. +1 −1 lib/cape/util.rb
View
@@ -10,6 +10,8 @@ class Capistrano
attr_accessor :rake
# Constructs a new Capistrano object with the specified _attributes_.
+ #
+ # @param [Hash] attributes attribute values
def initialize(attributes={})
attributes.each do |name, value|
send "#{name}=", value
View
@@ -9,7 +9,7 @@ module DSL
# Enumerates Rake tasks.
#
# @param [String, Symbol] task_expression the full name of a task or
- # namespace to filter; optional
+ # namespace to filter
# @param [Proc] block a block that processes tasks
#
# @yield [task] a block that processes tasks
@@ -96,7 +96,7 @@ def method_missing(method, *args, &block)
# Defines Rake tasks as Capistrano recipes.
#
# @param [String, Symbol] task_expression the full name of a Rake task or
- # namespace to filter; optional
+ # namespace to filter
#
# @yield [env] a block that defines environment variables for the Rake
# task; optional
View
@@ -29,6 +29,8 @@ class Rake
attr_writer :remote_executable
# Constructs a new Rake object with the specified _attributes_.
+ #
+ # @param [Hash] attributes attribute values
def initialize(attributes={})
attributes.each do |name, value|
send "#{name}=", value
@@ -39,8 +41,8 @@ def initialize(attributes={})
#
# @param [Object] other another object
#
- # @return [true] the Rake object is equal to _other_
- # @return [false] the Rake object is unequal to _other_
+ # @return [true] the {Rake} object is equal to _other_
+ # @return [false] the {Rake} object is unequal to _other_
def ==(other)
other.kind_of?(Rake) &&
(other.local_executable == local_executable) &&
@@ -50,7 +52,7 @@ def ==(other)
# Enumerates Rake tasks.
#
# @param [String, Symbol] task_expression the full name of a task or
- # namespace to filter; optional
+ # namespace to filter
#
# @yield [task] a block that processes tasks
# @yieldparam [Hash] task metadata on a task
View
@@ -6,7 +6,7 @@ module Util
# Conditionally transforms the specified _noun_ into its plural form.
#
# @param [String] singular_noun a singular noun
- # @param [Fixnum] count the quantity of _singular_noun_; optional
+ # @param [Fixnum] count the quantity of _singular_noun_
#
# @return [String] the plural of _singular_noun_, unless _count_ is +1+
def self.pluralize(singular_noun, count=2)

0 comments on commit 3ff5ec6

Please sign in to comment.