Handles the mapping of a file’s information to HTML. In reality, a file corresponds to a TopLevel object, containing modules, classes, and top-level methods. In theory it could contain attributes and aliases, but we ignore these for now.
Handles the mapping of a file’s information to HTML. In reality, a file corresponds to a TopLevel object, containing modules, classes, and top-level methods. In theory it could contain attributes and aliases, but we ignore these for now.
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 756 def initialize(context, options, file_dir) super(context, options) @@f_seq = @@f_seq.succ @f_seq = @@f_seq @values = {} @path = http_url(file_dir) @source_file_path = File.expand_path(@context.file_relative_name).gsub("\/doc\/", "/") @name = @context.file_relative_name collect_methods AllReferences.add(name, self) context.viewer = self end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 899 def <=>(other) self.name <=> other.name end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 783 def aref @f_seq end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 880 def file_attribute_values full_path = @context.file_absolute_name short_name = File.basename(full_path) @values["title"] = CGI.escapeHTML("File: #{short_name}") if @context.diagram @values["diagram"] = diagram_reference(@context.diagram) end @values["short_name"] = CGI.escapeHTML(short_name) @values["full_path"] = CGI.escapeHTML(full_path) @values["dtm_modified"] = @context.file_stat.mtime.to_s if @options.webcvs @values["cvsurl"] = cvs_url( @options.webcvs, @values["full_path"] ) end end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 775 def filename_to_label @context.file_relative_name.gsub(/%|\/|\?|\#/) {|s| '%' + ("%x" % s[0]) } end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 804 def full_file_source ret_str = "" File.open(@source_file_path, 'r') do |f| while(!f.eof?) do ret_str += f.readline() end end ret_str rescue "file not found -#{@source_file_path}-" #@source_file_path end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 792 def full_name @context.file_absolute_name end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 771 def http_url(file_dir) File.join(file_dir, @context.file_relative_name.tr('.', '_')) + ".html" end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 800 def parent_name nil end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 796 def scope @context.file_relative_name.gsub(/\/#{name}$/, '') end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 779 def seq @f_seq end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 817 def value_hash file_attribute_values add_table_of_sections @values["charset"] = @options.charset @values["href"] = path @values["style_url"] = style_url(path, @options.css) @values["file_seq"] = seq #pulling in the source for this file #@values["source_code"] = @context.token_stream @values["file_source_code"] = CGI.escapeHTML(full_file_source) if @context.comment d = markup(@context.comment) @values["description"] = d if d.size > 0 end ml = build_method_summary_list @values["methods"] = ml unless ml.empty? il = build_include_list(@context) @values["includes"] = il unless il.empty? rl = build_requires_list(@context) @values["requires"] = rl unless rl.empty? file_context = @context @values["sections"] = @context.sections.map do |section| secdata = { "sectitle" => section.title, "secsequence" => section.sequence, "seccomment" => markup(section.comment) } cl = build_class_list(0, @context, section, file_context) @values["classlist"] = cl unless cl.empty? mdl = build_method_detail_list(section) secdata["method_list"] = mdl unless mdl.empty? al = build_alias_summary_list(section) secdata["aliases"] = al unless al.empty? co = build_constants_summary_list(section) @values["constants"] = co unless co.empty? secdata end @values end
# File lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb, line 874 def write_on(f) value_hash template = TemplatePage.new(RDoc::Page::SRC_BODY,RDoc::Page::FILE_PAGE, RDoc::Page::METHOD_LIST) template.write_html_on(f, @values) end
Generated with the Darkfish Rdoc Generator 2.