Permalink
Browse files

Updates system documentation

  • Loading branch information...
1 parent c50433f commit 8be85cae1d6232e824b1fee031d6d51886003246 @Groogy committed Apr 19, 2012
Showing with 22 additions and 2 deletions.
  1. +0 −1 ext/System/Clock.rb
  2. +18 −0 ext/System/NonCopyable.rb
  3. +1 −0 ext/System/Time.rb
  4. +2 −1 ext/System/Vector2.rb
  5. +1 −0 ext/System/Vector3.rb
View
@@ -15,7 +15,6 @@ class Clock
# @return [Time] The elapsed Time
def elapsed_time
end
- alias elapsedTime elapsed_time
alias getElapsedTime elapsed_time
alias get_elapsed_time elapsed_time
alias time elapsed_time
View
@@ -0,0 +1,18 @@
+module SFML
+
+ # Utility mixin module that makes any derived class non-copyable.
+ #
+ # This module makes its instances non-copyable, by explicitely disabling its copy initializer.
+ #
+ # To create a non-copyable class, simply mixin from SFML::NonCopyable.
+ #
+ # Deciding whether the instances of a class can be copied or not is a very important design choice. You are strongly encouraged to think about it before writing a class, and to use SFML::NonCopyable when necessary to prevent many potential future errors when using it. This is also a very important indication to users of your class.
+ #
+ # @example
+ # class MyNonCopyableClass
+ # include SFML::NonCopyable
+ # end
+ #
+ module NonCopyable
+ end
+end
View
@@ -66,6 +66,7 @@ def +( right )
# @param [Time] right Time value to subtract with.
# @return [Time] The difference of the Time values.
def -( right )
+ end
# Multiply the time value with a factor.
# @overload *( right )
View
@@ -21,7 +21,8 @@ module SFML
# @note for 3-dimensional vectors, see <tt>Vector3</tt>.
#
# @example
- # v1 = Vector2.new(16.5, 24)
+ # v1 = SFML::Vector2.new(16.5, 24)
+ # v1 == [16.5, 24]
# v1.x = 18.2
# y = v1.y
# v2 = v1 * 5
View
@@ -22,6 +22,7 @@ module SFML
#
# @example
# v1 = Vector3.new(16.5, 24, -8.2)
+ # v1 == [16.5, 24, -8.2]
# v1.x = 18.2
# y = v1.y
# z = v1.z

0 comments on commit 8be85ca

Please sign in to comment.