Home » Rails main » Index (A) » RDoc » Generator » API ▲
123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Generator::API

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, RDoc::Generator::SDoc
Instance Chain:
self, RDoc::Generator::SDoc
Inherits: RDoc::Generator::SDoc
  • ::Object
Defined in: railties/lib/rails/api/generator.rb

Instance Method Summary

Instance Method Details

#active_storage?(klass) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'railties/lib/rails/api/generator.rb', line 35



def active_storage?(klass)
  klass.name != "ActiveStorage" && klass.in_files.all? { |file| file.absolute_name.include?("active_storage") }
end


  








  

    #build_core_ext_subtree(classes, visited)   (private)
  

  [ GitHub ]


  

  


# File 'railties/lib/rails/api/generator.rb', line 24



def build_core_ext_subtree(classes, visited)
  classes.map do |klass|
    [ klass.name, klass.document_self_or_methods ? klass.path : "", "",
        generate_class_tree_level(klass.classes_and_modules, visited) ]
  end
end


  








  

    #core_extension?(klass)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'railties/lib/rails/api/generator.rb', line 31



def core_extension?(klass)
  klass.name != "ActiveSupport" && klass.in_files.any? { |file| file.absolute_name.include?("core_ext") }
end


  








  

    #generate_class_tree_level(classes, visited = {})  
  

  [ GitHub ]


  

  


# File 'railties/lib/rails/api/generator.rb', line 9



def generate_class_tree_level(classes, visited = {})
  # Only process core extensions on the first visit and remove
  # Active Storage duplicated classes that are at the top level
  # since they aren't nested under a definition of the `ActiveStorage` module.
  if visited.empty?
    classes = classes.reject { |klass| active_storage?(klass) }
    core_exts = classes.extract! { |klass| core_extension?(klass) }

    super.unshift([ "Core extensions", "", "", build_core_ext_subtree(core_exts, visited) ])
  else
    super
  end
end