public
Description: Dependency Resolution Framework
Homepage: http://warningshot.lighthouseapp.com
Clone URL: git://github.com/coryodaniel/warningshot.git
coryodaniel (author)
Thu Feb 26 17:40:45 -0800 2009
commit  57c993689114a1ee04bdf558ec9f5607851e2ccf
tree    f9c34cc23f84172f67fbaf16c21fdb4d508566f3
parent  4bf02c372017d7458ed618f11a7c82c70c64e609
warningshot / yardoc_template.txt
100755 48 lines (44 sloc) 0.834 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class Whatever
  
  # This method adds two things together
  #
  # @param p1 [Fixnum]
  # The first number
  #
  # @param p2 [Fixnum]
  # The second number
  #
  # @return [Fixnum]
  # The sum
  #
  # @example
  # some_method(3,5) => 8
  #
  # @notes
  # This method is rediculous
  #
  # @api public
  def some_method(p1,p2)
    return p1 + p2
  end
  
  # This method reverses an array
  #
  # @param *list [~to_s]
  # A list of things that quack like a string
  #
  # @return [Array(~to_s)]
  # The list in an array, how useful.
  #
  # @example
  # old_dangerous_method("this","that","the other") => ["this","that","the other"]
  #
  # @raise HolyCrap
  #
  # @deprecated
  # @api public
  def old_dangerous_method(*list)
    if list.empty?
      raise "HolyCrap"
    end
    
    return list.reverse
  end
  
end