Changeset 27506

Timestamp:

12/28/08 11:48:10 (4 years ago)

Author:

isaisstillalive

Message:

• 関数形式で呼び出して欲しいメソッドをprivateに変更。
  
• rdocコメントの調整。privateを常に表示するようにし、nodoc/stopdoc/startdocで調整するようにした。
  

Location:

lang/ruby/starframe

Files:

• lib/starframe/eventable.rb (modified) (3 diffs)
• lib/starframe/sprite.rb (modified) (6 diffs)
• lib/starframe/sprite/animatable.rb (modified) (6 diffs)
• lib/starframe/sprite/animation.rb (modified) (4 diffs)
• lib/starframe/sprite/collidable.rb (modified) (1 diff)
• lib/starframe/sprite/patternable.rb (modified) (2 diffs)
• mkrdoc.bat (modified) (1 diff)

lang/ruby/starframe/lib/starframe/eventable.rb

@@ -2 +2 @@
 
 module StarFrame
-  # = Eventableモジュール
   # イベント駆動を実装するモジュール。
   # 
@@ -8 +7 @@
   # 
   # また、メソッドチェインを利用して各イベントの前後に他の処理を割り込ませることができる。
+  # 
+  # 独自クラスにこのモジュールをincludeすることで、Sprite::Animatable等のモジュールを使用することができるようになる。
   module Eventable
+    #:stopdoc:
+    def self.included klass
+      klass.extend ClassMethods
+    end
+    #:startdoc:
+    
     # 初期化時イベントをコールする。
     def call_init *args
@@ -40 +47 @@
     
     private
-    # 初期化時にコールされるイベント。
+    # 初期化時に呼ばれます。
+    # 引数にはnewに渡された全ての引数が渡されます。
     def init *args
-      #:doc:
     end
-    # 終了時にコールされるイベント。
+    # 消滅したときに呼ばれます。
     def quit
-      #:doc:
     end
-    # 更新時にコールされるイベント。
+    # 更新時に呼ばれます。
     def update
-      #:doc:
     end
-    # 描画時にコールされるイベント。
+    # 描画時に呼ばれます。
     def render
-      #:doc:
-    end
-    
-    def self.included klass #:nodoc:
-      klass.extend ClassMethods
     end
     

lang/ruby/starframe/lib/starframe/sprite.rb

@@ -11 +11 @@
     
     module ClassMethods
+      #:stopdoc:
       private
       # オプション用アクセサ定義メソッド
-      def attr_option_accessor *keys #:nodoc:
+      def attr_option_accessor *keys
         keys.each do |key|
           define_option_writer key, key
@@ -21 +22 @@
       
       # オプション一括変更用アクセサ定義メソッド
-      def attr_option_slimer_writer name, keys #:nodoc:
+      def attr_option_slimer_writer name, keys
         define_option_writer name, *keys
       end
       
-      def define_option_writer name, *keys #:nodoc:
+      def define_option_writer name, *keys
         default = OPTIONS_DEFAULT[keys.first]
         
@@ -48 +49 @@
         END
       end
+      #:startdoc:
     end
   end
@@ -290 +292 @@
     end
     
-    def call_update#:nodoc:
+    def call_update #:nodoc:
       move
       update
@@ -296 +298 @@
     
     private
-    def initialize_texture
+    def initialize_texture #:nodoc:
       @texture           ||= self.class.texture
       @center_x, @center_y = self.class.center_x, self.class.center_y
@@ -311 +313 @@
     end
     
-    # render_toメソッドの最適化
-    def redifine_render_to #:doc:
+    # render_toメソッドを最適化する
+    # 
+    # 通常はinitialize内で自動的に実行されるため、ユーザが実行する必要はない。
+    def redifine_render_to
       instance_eval <<-END
         def render_to other

lang/ruby/starframe/lib/starframe/sprite/animatable.rb

@@ -19 +19 @@
     #   end
     module Animatable
-      def self.included sprite #:nodoc:
+      #:stopdoc:
+      def self.included sprite
         unless sprite.include? StarFrame::Eventable
           raise TypeError, "StarFrame::Sprite::Animatable : has need \"include StarFrame::Eventable\"", caller
@@ -26 +27 @@
       end
       
-      def call_init_with_animation *args #:nodoc:
+      def call_init_with_animation *args
         @animations = {}
         self.class.animations.each do |name, animation_class|
@@ -34 +35 @@
       end
       
-      def call_update_with_animation #:nodoc:
+      def call_update_with_animation
         call_update_without_animation
         
@@ -41 +42 @@
         end
       end
+      #:startdoc:
       
       # アニメーションを取得
@@ -48 +50 @@
       
       module ClassMethods
-        attr_accessor :animations #:nodoc:
+        #:stopdoc:
+        attr_reader :animations
         
-        def self.extended sprite #:nodoc:
+        private
+        def self.extended sprite
           sprite.instance_variable_set :@animations, {}
           sprite.alias_method_chain :call_init,   :animation
@@ -56 +60 @@
         end
         
-        def inherited klass #:nodoc:
+        def inherited klass
           klass.instance_variable_set :@animations,  @animations.dup
           super
         end
+        #:startdoc:
         
+        private
         # アニメーションを定義
         # 

lang/ruby/starframe/lib/starframe/sprite/animation.rb

@@ -9 +9 @@
       # 初期化
       def initialize sprite
-        # @max_frameが0の時に例外出したい
         @sprite = sprite
         @animations = self.class.animations
+        
+        # @max_frameが0の時に例外出したい
         @max_frame = self.class.max_frame
         @frame = 0
         
-        options = self.class.instance_variable_get(:@options)
+        options = self.class.options
         @loop    = (options[:loop].nil?  ? true : options[:loop])
         @running = (options[:start].nil? ? true : options[:start])
@@ -62 +63 @@
       
       module ClassMethods
+        #:stopdoc:
+        attr_reader :animations, :max_frame, :options
         @@method_count = 0
-        attr_reader :animations, :max_frame
-        
-        def self.extended sprite #:nodoc:
+        
+        private
+        def self.extended sprite
+          sprite.instance_variable_set :@animations, Hash.new{ |hash, key| hash[key] = [] }
           sprite.instance_variable_set :@max_frame,  0
-          sprite.instance_variable_set :@animations, Hash.new{ |hash, key| hash[key] = [] }
           sprite.instance_variable_set :@options,    {}
         end
         
-        def inherited klass #:nodoc:
+        def inherited klass
+          klass.instance_variable_set :@animations, @animations.dup
           klass.instance_variable_set :@max_frame,  @max_frame
-          klass.instance_variable_set :@animations, @animations.dup
           klass.instance_variable_set :@options,    @options
           super
         end
-        
-        protected
+        #:startdoc:
+        
+        private
         # タイムラインを直列モードに変更するブロック。
         # 
@@ -100 +104 @@
         
         # タイムラインのモードを変更するブロック。
+        # 
+        # serialメソッドとparallelメソッドの共通ロジック。
+        # 通常は使用する必要はない。
         def timeline parallel = false, &block
           last_parallel = @parallel
@@ -108 +115 @@
           @parallel = last_parallel
         end
-        private :timeline
         
         # アニメーションを追加する。

lang/ruby/starframe/lib/starframe/sprite/collidable.rb

@@ -53 +53 @@
       
       module ClassMethods
-        attr_accessor :collisions #:nodoc:
+        #:stopdoc:
+        attr_reader :collisions
         
-        def self.extended sprite #:nodoc:
+        private
+        def self.extended sprite
           sprite.instance_variable_set :@collisions, {}
           sprite.alias_method_chain :call_init, :collision
         end
         
-        def inherited klass #:nodoc:
+        def inherited klass
           klass.instance_variable_set :@collisions,  @collisions.dup
           super
         end
+        #:startdoc:
         
+        private
         # 当たり判定を定義
         # 

lang/ruby/starframe/lib/starframe/sprite/patternable.rb

@@ -20 +20 @@
       # 現在のパターン番号
       attr_reader :pattern_index
-      # パターン番号を設定する
+      # パターン番号を変更する
       def pattern_index= index
         @pattern_index = index
@@ -26 +26 @@
       end
       
-      module ClassMethods #:nodoc:
-        attr_reader :patterns #:nodoc:
+      #:stopdoc:
+      module ClassMethods
+        attr_reader :patterns
         
-        def self.extended sprite #:nodoc:
+        private
+        def self.extended sprite
           sprite.instance_variable_set :@patterns, []
           sprite.alias_method_chain :initialize,  :pattern
         end
         
-        def inherited klass #:nodoc:
+        def inherited klass
           klass.instance_variable_set :@patterns, @patterns.dup
           super
         end
       end
+      #:startdoc:
     end
   end

lang/ruby/starframe/mkrdoc.bat

@@ -1 @@
-rdoc lib -U --op doc --charset UTF-8 --inline-source --title "StarFrame RDoc Documentation" --main StarFrame --accessor attr_option_accessor=rw --accessor attr_option_slimer_writer=w
+rdoc lib -U --op doc --charset UTF-8 --inline-source --title "StarFrame RDoc Documentation" --main StarFrame --accessor attr_option_accessor=rw --accessor attr_option_slimer_writer=w --all