Changeset 27506 for lang/ruby/starframe

Show
Ignore:
Timestamp:
12/28/08 11:48:10 (6 years ago)
Author:
isaisstillalive
Message:
  • 関数形式で呼び出して欲しいメソッドをprivateに変更。
  • rdocコメントの調整。privateを常に表示するようにし、nodoc/stopdoc/startdocで調整するようにした。
Location:
lang/ruby/starframe
Files:
7 modified

Legend:

Unmodified
Added
Removed
  • lang/ruby/starframe/lib/starframe/eventable.rb

    r27475 r27506  
    22 
    33module StarFrame 
    4   # = Eventableモジュール 
    54  # イベント駆動を実装するモジュール。 
    65  #  
     
    87  #  
    98  # また、メソッドチェインを利用して各イベントの前後に他の処理を割り込ませることができる。 
     9  #  
     10  # 独自クラスにこのモジュールをincludeすることで、Sprite::Animatable等のモジュールを使用することができるようになる。 
    1011  module Eventable 
     12    #:stopdoc: 
     13    def self.included klass 
     14      klass.extend ClassMethods 
     15    end 
     16    #:startdoc: 
     17     
    1118    # 初期化時イベントをコールする。 
    1219    def call_init *args 
     
    4047     
    4148    private 
    42     # 初期化時にコールされるイベント。 
     49    # 初期化時に呼ばれます。 
     50    # 引数にはnewに渡された全ての引数が渡されます。 
    4351    def init *args 
    44       #:doc: 
    4552    end 
    46     # 終了時にコールされるイベント 
     53    # 消滅したときに呼ばれます 
    4754    def quit 
    48       #:doc: 
    4955    end 
    50     # 更新時にコールされるイベント 
     56    # 更新時に呼ばれます 
    5157    def update 
    52       #:doc: 
    5358    end 
    54     # 描画時にコールされるイベント 
     59    # 描画時に呼ばれます 
    5560    def render 
    56       #:doc: 
    57     end 
    58      
    59     def self.included klass #:nodoc: 
    60       klass.extend ClassMethods 
    6161    end 
    6262     
  • lang/ruby/starframe/lib/starframe/sprite.rb

    r27483 r27506  
    1111     
    1212    module ClassMethods 
     13      #:stopdoc: 
    1314      private 
    1415      # オプション用アクセサ定義メソッド 
    15       def attr_option_accessor *keys #:nodoc: 
     16      def attr_option_accessor *keys 
    1617        keys.each do |key| 
    1718          define_option_writer key, key 
     
    2122       
    2223      # オプション一括変更用アクセサ定義メソッド 
    23       def attr_option_slimer_writer name, keys #:nodoc: 
     24      def attr_option_slimer_writer name, keys 
    2425        define_option_writer name, *keys 
    2526      end 
    2627       
    27       def define_option_writer name, *keys #:nodoc: 
     28      def define_option_writer name, *keys 
    2829        default = OPTIONS_DEFAULT[keys.first] 
    2930         
     
    4849        END 
    4950      end 
     51      #:startdoc: 
    5052    end 
    5153  end 
     
    290292    end 
    291293     
    292     def call_update#:nodoc: 
     294    def call_update #:nodoc: 
    293295      move 
    294296      update 
     
    296298     
    297299    private 
    298     def initialize_texture 
     300    def initialize_texture #:nodoc: 
    299301      @texture           ||= self.class.texture 
    300302      @center_x, @center_y = self.class.center_x, self.class.center_y 
     
    311313    end 
    312314     
    313     # render_toメソッドの最適化 
    314     def redifine_render_to #:doc: 
     315    # render_toメソッドを最適化する 
     316    #  
     317    # 通常はinitialize内で自動的に実行されるため、ユーザが実行する必要はない。 
     318    def redifine_render_to 
    315319      instance_eval <<-END 
    316320        def render_to other 
  • lang/ruby/starframe/lib/starframe/sprite/animatable.rb

    r27493 r27506  
    1919    #   end 
    2020    module Animatable 
    21       def self.included sprite #:nodoc: 
     21      #:stopdoc: 
     22      def self.included sprite 
    2223        unless sprite.include? StarFrame::Eventable 
    2324          raise TypeError, "StarFrame::Sprite::Animatable : has need \"include StarFrame::Eventable\"", caller 
     
    2627      end 
    2728       
    28       def call_init_with_animation *args #:nodoc: 
     29      def call_init_with_animation *args 
    2930        @animations = {} 
    3031        self.class.animations.each do |name, animation_class| 
     
    3435      end 
    3536       
    36       def call_update_with_animation #:nodoc: 
     37      def call_update_with_animation 
    3738        call_update_without_animation 
    3839         
     
    4142        end 
    4243      end 
     44      #:startdoc: 
    4345       
    4446      # アニメーションを取得 
     
    4850       
    4951      module ClassMethods 
    50         attr_accessor :animations #:nodoc: 
     52        #:stopdoc: 
     53        attr_reader :animations 
    5154         
    52         def self.extended sprite #:nodoc: 
     55        private 
     56        def self.extended sprite 
    5357          sprite.instance_variable_set :@animations, {} 
    5458          sprite.alias_method_chain :call_init,   :animation 
     
    5660        end 
    5761         
    58         def inherited klass #:nodoc: 
     62        def inherited klass 
    5963          klass.instance_variable_set :@animations,  @animations.dup 
    6064          super 
    6165        end 
     66        #:startdoc: 
    6267         
     68        private 
    6369        # アニメーションを定義 
    6470        #  
  • lang/ruby/starframe/lib/starframe/sprite/animation.rb

    r27505 r27506  
    99      # 初期化 
    1010      def initialize sprite 
    11         # @max_frameが0の時に例外出したい 
    1211        @sprite = sprite 
    1312        @animations = self.class.animations 
     13         
     14        # @max_frameが0の時に例外出したい 
    1415        @max_frame = self.class.max_frame 
    1516        @frame = 0 
    1617         
    17         options = self.class.instance_variable_get(:@options) 
     18        options = self.class.options 
    1819        @loop    = (options[:loop].nil?  ? true : options[:loop]) 
    1920        @running = (options[:start].nil? ? true : options[:start]) 
     
    6263       
    6364      module ClassMethods 
     65        #:stopdoc: 
     66        attr_reader :animations, :max_frame, :options 
    6467        @@method_count = 0 
    65         attr_reader :animations, :max_frame 
    66          
    67         def self.extended sprite #:nodoc: 
     68         
     69        private 
     70        def self.extended sprite 
     71          sprite.instance_variable_set :@animations, Hash.new{ |hash, key| hash[key] = [] } 
    6872          sprite.instance_variable_set :@max_frame,  0 
    69           sprite.instance_variable_set :@animations, Hash.new{ |hash, key| hash[key] = [] } 
    7073          sprite.instance_variable_set :@options,    {} 
    7174        end 
    7275         
    73         def inherited klass #:nodoc: 
     76        def inherited klass 
     77          klass.instance_variable_set :@animations, @animations.dup 
    7478          klass.instance_variable_set :@max_frame,  @max_frame 
    75           klass.instance_variable_set :@animations, @animations.dup 
    7679          klass.instance_variable_set :@options,    @options 
    7780          super 
    7881        end 
    79          
    80         protected 
     82        #:startdoc: 
     83         
     84        private 
    8185        # タイムラインを直列モードに変更するブロック。 
    8286        #  
     
    100104         
    101105        # タイムラインのモードを変更するブロック。 
     106        #  
     107        # serialメソッドとparallelメソッドの共通ロジック。 
     108        # 通常は使用する必要はない。 
    102109        def timeline parallel = false, &block 
    103110          last_parallel = @parallel 
     
    108115          @parallel = last_parallel 
    109116        end 
    110         private :timeline 
    111117         
    112118        # アニメーションを追加する。 
  • lang/ruby/starframe/lib/starframe/sprite/collidable.rb

    r27489 r27506  
    5353       
    5454      module ClassMethods 
    55         attr_accessor :collisions #:nodoc: 
     55        #:stopdoc: 
     56        attr_reader :collisions 
    5657         
    57         def self.extended sprite #:nodoc: 
     58        private 
     59        def self.extended sprite 
    5860          sprite.instance_variable_set :@collisions, {} 
    5961          sprite.alias_method_chain :call_init, :collision 
    6062        end 
    6163         
    62         def inherited klass #:nodoc: 
     64        def inherited klass 
    6365          klass.instance_variable_set :@collisions,  @collisions.dup 
    6466          super 
    6567        end 
     68        #:startdoc: 
    6669         
     70        private 
    6771        # 当たり判定を定義 
    6872        #  
  • lang/ruby/starframe/lib/starframe/sprite/patternable.rb

    r27423 r27506  
    2020      # 現在のパターン番号 
    2121      attr_reader :pattern_index 
    22       # パターン番号を設定する 
     22      # パターン番号を変更する 
    2323      def pattern_index= index 
    2424        @pattern_index = index 
     
    2626      end 
    2727       
    28       module ClassMethods #:nodoc: 
    29         attr_reader :patterns #:nodoc: 
     28      #:stopdoc: 
     29      module ClassMethods 
     30        attr_reader :patterns 
    3031         
    31         def self.extended sprite #:nodoc: 
     32        private 
     33        def self.extended sprite 
    3234          sprite.instance_variable_set :@patterns, [] 
    3335          sprite.alias_method_chain :initialize,  :pattern 
    3436        end 
    3537         
    36         def inherited klass #:nodoc: 
     38        def inherited klass 
    3739          klass.instance_variable_set :@patterns, @patterns.dup 
    3840          super 
    3941        end 
    4042      end 
     43      #:startdoc: 
    4144    end 
    4245  end 
  • lang/ruby/starframe/mkrdoc.bat

    r27496 r27506  
    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 
     1rdoc 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