rdoc 6.13.1 → 6.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d37c61d3b62301d9edb9907e9d479ed46ee9c930ef642ab50c5a8ef9793aa6c
-  data.tar.gz: 987db79f9426bf33980775d980fc0ea36f527f74dd2098433450ee18a3ab1715
+  metadata.gz: 0a7e93ac9c35220aeef63714f07b7ad32fc23de76e17e92e32a49012e32f304e
+  data.tar.gz: f273ce6acb9a2caf5e663ddfaae80d676a07e2b0e2d7de818218da742ed795d4
 SHA512:
-  metadata.gz: f6afade46cb94e3cbd3d595d49ae76d41b07a4c987e4a30159558caf368453628ddf7f790c9eeb0d95023323f5ff63c2e64df8ec99b1fb87a1b490bc42feb23b
-  data.tar.gz: 8e7e146ab28264fc33223f1e31c38985844718bc679aa7c11e0daef73edef93325f322c60fc1b78d5182d426ef972b6f685b31010f55f5e02be2d0a333972eb0
+  metadata.gz: 5deecbe6a6a8562324936b2c458c45be5565832ec9ff2ac2fb79f6c2dd8d72add9e08c24485eaa7365d5d0628abed02d0d6a198067d64f0217a6789633c7e57e
+  data.tar.gz: 1ca6dad24e4f748fa8863e301c5f87a89b174523eaf62f2ab505845b2f15aaa4e6a7b215c7ff325c198052358ebfd9c206f0b743c2f97da0eff7444c0edacf96

data/README.rdoc

@@ -54,6 +54,8 @@ To generate documentation programmatically:
   require 'rdoc/rdoc'
 
   options = RDoc::Options.new
+  options.files = ['a.rb', 'b.rb']
+  options.setup_generator 'darkfish'
   # see RDoc::Options
 
   rdoc = RDoc::RDoc.new
@@ -121,7 +123,7 @@ Please follow the theme's README for usage instructions.
 
 == Bugs
 
-See CONTRIBUTING@Bugs for information on filing a bug report.  It's OK to file
+See CONTRIBUTING.rdoc for information on filing a bug report.  It's OK to file
 a bug report for anything you're having a problem with.  If you can't figure
 out how to make RDoc produce the output you like that is probably a
 documentation bug.

data/lib/rdoc/code_object/any_method.rb

@@ -52,7 +52,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   ##
   # Adds +an_alias+ as an alias for this method in +context+.
 
-  def add_alias an_alias, context = nil
+  def add_alias(an_alias, context = nil)
     method = self.class.new an_alias.text, an_alias.new_name, singleton: singleton
 
     method.record_location an_alias.file
@@ -104,7 +104,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   #
   # See also #param_seq
 
-  def call_seq= call_seq
+  def call_seq=(call_seq)
     return if call_seq.nil? || call_seq.empty?
 
     @call_seq = call_seq
@@ -176,7 +176,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize_visibility
 
     @dont_rename_initialize = nil
@@ -309,7 +309,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   ##
   # Sets the store for this method and its referenced code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @file = @store.add_file @file.full_name if @file

data/lib/rdoc/code_object/attr.rb

@@ -32,7 +32,7 @@ class RDoc::Attr < RDoc::MethodAttr
   ##
   # Attributes are equal when their names, singleton and rw are identical
 
-  def == other
+  def ==(other)
     self.class == other.class and
       self.name == other.name and
       self.rw == other.rw and
@@ -118,7 +118,7 @@ class RDoc::Attr < RDoc::MethodAttr
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize_visibility
 
     @aliases      = []
@@ -145,7 +145,7 @@ class RDoc::Attr < RDoc::MethodAttr
     @parent_name ||= @full_name.split('#', 2).first
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[#{self.class.name} #{full_name} #{rw} #{visibility}", "]" do
       unless comment.empty? then
         q.breakable

data/lib/rdoc/code_object/class_module.rb

@@ -45,7 +45,7 @@ class RDoc::ClassModule < RDoc::Context
   #--
   # TODO move to RDoc::NormalClass (I think)
 
-  def self.from_module class_type, mod
+  def self.from_module(class_type, mod)
     klass = class_type.new mod.name
 
     mod.comment_location.each do |comment, location|
@@ -120,7 +120,7 @@ class RDoc::ClassModule < RDoc::Context
   # method is preferred over #comment= since it allows ri data to be updated
   # across multiple runs.
 
-  def add_comment comment, location
+  def add_comment(comment, location)
     return unless document_self
 
     original = comment
@@ -141,7 +141,7 @@ class RDoc::ClassModule < RDoc::Context
     self.comment = original
   end
 
-  def add_things my_things, other_things # :nodoc:
+  def add_things(my_things, other_things) # :nodoc:
     other_things.each do |group, things|
       my_things[group].each { |thing| yield false, thing } if
         my_things.include? group
@@ -198,7 +198,7 @@ class RDoc::ClassModule < RDoc::Context
   # Appends +comment+ to the current comment, but separated by a rule.  Works
   # more like <tt>+=</tt>.
 
-  def comment= comment # :nodoc:
+  def comment=(comment) # :nodoc:
     comment = case comment
               when RDoc::Comment then
                 comment.normalize
@@ -216,7 +216,7 @@ class RDoc::ClassModule < RDoc::Context
   #
   # See RDoc::Store#complete
 
-  def complete min_visibility
+  def complete(min_visibility)
     update_aliases
     remove_nodoc_children
     embed_mixins
@@ -259,7 +259,7 @@ class RDoc::ClassModule < RDoc::Context
   ##
   # Looks for a symbol in the #ancestors. See Context#find_local_symbol.
 
-  def find_ancestor_local_symbol symbol
+  def find_ancestor_local_symbol(symbol)
     each_ancestor do |m|
       res = m.find_local_symbol(symbol)
       return res if res
@@ -271,7 +271,7 @@ class RDoc::ClassModule < RDoc::Context
   ##
   # Finds a class or module with +name+ in this namespace or its descendants
 
-  def find_class_named name
+  def find_class_named(name)
     return self if full_name == name
     return self if @name == name
 
@@ -360,7 +360,7 @@ class RDoc::ClassModule < RDoc::Context
     ]
   end
 
-  def marshal_load array # :nodoc:
+  def marshal_load(array) # :nodoc:
     initialize_visibility
     initialize_methods_etc
     @current_section   = nil
@@ -450,7 +450,7 @@ class RDoc::ClassModule < RDoc::Context
   #
   # The data in +class_module+ is preferred over the receiver.
 
-  def merge class_module
+  def merge(class_module)
     @parent      = class_module.parent
     @parent_name = class_module.parent_name
 
@@ -535,7 +535,7 @@ class RDoc::ClassModule < RDoc::Context
   #     end
   #   end
 
-  def merge_collections mine, other, other_files, &block # :nodoc:
+  def merge_collections(mine, other, other_files, &block) # :nodoc:
     my_things    = mine. group_by { |thing| thing.file }
     other_things = other.group_by { |thing| thing.file }
 
@@ -547,7 +547,7 @@ class RDoc::ClassModule < RDoc::Context
   # Merges the comments in this ClassModule with the comments in the other
   # ClassModule +cm+.
 
-  def merge_sections cm # :nodoc:
+  def merge_sections(cm) # :nodoc:
     my_sections    =    sections.group_by { |section| section.title }
     other_sections = cm.sections.group_by { |section| section.title }
 
@@ -595,7 +595,7 @@ class RDoc::ClassModule < RDoc::Context
   #
   # Used for modules and classes that are constant aliases.
 
-  def name= new_name
+  def name=(new_name)
     @name = new_name
   end
 
@@ -603,7 +603,7 @@ class RDoc::ClassModule < RDoc::Context
   # Parses +comment_location+ into an RDoc::Markup::Document composed of
   # multiple RDoc::Markup::Documents with their file set.
 
-  def parse comment_location
+  def parse(comment_location)
     case comment_location
     when String then
       super
@@ -675,7 +675,7 @@ class RDoc::ClassModule < RDoc::Context
     end
   end
 
-  def remove_things my_things, other_files # :nodoc:
+  def remove_things(my_things, other_files) # :nodoc:
     my_things.delete_if do |file, things|
       next false unless other_files.include? file
 
@@ -705,7 +705,7 @@ class RDoc::ClassModule < RDoc::Context
   ##
   # Sets the store for this class or module and its contained code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @attributes .each do |attr|  attr.store  = store end

data/lib/rdoc/code_object/constant.rb

@@ -44,7 +44,7 @@ class RDoc::Constant < RDoc::CodeObject
   ##
   # Constants are ordered by name
 
-  def <=> other
+  def <=>(other)
     return unless self.class === other
 
     [parent_name, name] <=> [other.parent_name, other.name]
@@ -53,7 +53,7 @@ class RDoc::Constant < RDoc::CodeObject
   ##
   # Constants are equal when their #parent and #name is the same
 
-  def == other
+  def ==(other)
     self.class == other.class and
       @parent == other.parent and
       @name == other.name
@@ -132,7 +132,7 @@ class RDoc::Constant < RDoc::CodeObject
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize array[1], nil, RDoc::Comment.from_document(array[5])
 
     @full_name     = array[2]
@@ -154,7 +154,7 @@ class RDoc::Constant < RDoc::CodeObject
     "#{@parent.path}##{@name}"
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[#{self.class.name} #{full_name}", "]" do
       unless comment.empty? then
         q.breakable
@@ -168,7 +168,7 @@ class RDoc::Constant < RDoc::CodeObject
   ##
   # Sets the store for this class or module and its contained code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @file = @store.add_file @file.full_name if @file

data/lib/rdoc/code_object/context/section.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'cgi/util'
+require 'cgi/escape'
+require 'cgi/util' unless defined?(CGI::EscapeExt)
 
 ##
 # A section of documentation like:
@@ -39,7 +40,7 @@ class RDoc::Context::Section
   ##
   # Creates a new section with +title+ and +comment+
 
-  def initialize parent, title, comment
+  def initialize(parent, title, comment)
     @parent = parent
     @title = title ? title.strip : title
 
@@ -51,7 +52,7 @@ class RDoc::Context::Section
   ##
   # Sections are equal when they have the same #title
 
-  def == other
+  def ==(other)
     self.class === other and @title == other.title
   end
 
@@ -60,7 +61,7 @@ class RDoc::Context::Section
   ##
   # Adds +comment+ to this section
 
-  def add_comment comment
+  def add_comment(comment)
     comments = Array(comment)
     comments.each do |c|
       extracted_comment = extract_comment(c)
@@ -86,7 +87,7 @@ class RDoc::Context::Section
   #   # :section: The title
   #   # The body
 
-  def extract_comment comment
+  def extract_comment(comment)
     case comment
     when nil
       RDoc::Comment.new ''
@@ -138,7 +139,7 @@ class RDoc::Context::Section
   ##
   # De-serializes this Section.  The section parent must be restored manually.
 
-  def marshal_load array
+  def marshal_load(array)
     @parent  = nil
 
     @title    = array[1]
@@ -166,7 +167,7 @@ class RDoc::Context::Section
   # Removes a comment from this section if it is from the same file as
   # +comment+
 
-  def remove_comment target_comment
+  def remove_comment(target_comment)
     @comments.delete_if do |stored_comment|
       stored_comment.file == target_comment.file
     end

data/lib/rdoc/code_object/context.rb

@@ -180,7 +180,7 @@ class RDoc::Context < RDoc::CodeObject
   #
   # Currently only RDoc::Extend and RDoc::Include are supported.
 
-  def add klass, name, comment
+  def add(klass, name, comment)
     if RDoc::Extend == klass then
       ext = RDoc::Extend.new name, comment
       add_extend ext
@@ -195,7 +195,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Adds +an_alias+ that is automatically resolved
 
-  def add_alias an_alias
+  def add_alias(an_alias)
     return an_alias unless @document_self
 
     method_attr = find_method(an_alias.old_name, an_alias.singleton) ||
@@ -222,7 +222,7 @@ class RDoc::Context < RDoc::CodeObject
   # if method +foo+ exists, but <tt>attr_accessor :foo</tt> will be registered
   # if method +foo+ exists, but <tt>foo=</tt> does not.
 
-  def add_attribute attribute
+  def add_attribute(attribute)
     return attribute unless @document_self
 
     # mainly to check for redefinition of an attribute as a method
@@ -285,7 +285,7 @@ class RDoc::Context < RDoc::CodeObject
   # unless it later sees <tt>class Container</tt>.  +add_class+ automatically
   # upgrades +given_name+ to a class in this case.
 
-  def add_class class_type, given_name, superclass = '::Object'
+  def add_class(class_type, given_name, superclass = '::Object')
     # superclass +nil+ is passed by the C parser in the following cases:
     # - registering Object in 1.8 (correct)
     # - registering BasicObject in 1.9 (correct)
@@ -401,7 +401,7 @@ class RDoc::Context < RDoc::CodeObject
   # unless #done_documenting is +true+. Sets the #parent of +mod+
   # to +self+, and its #section to #current_section. Returns +mod+.
 
-  def add_class_or_module mod, self_hash, all_hash
+  def add_class_or_module(mod, self_hash, all_hash)
     mod.section = current_section # TODO declaring context? something is
                                   # wrong here...
     mod.parent = self
@@ -426,7 +426,7 @@ class RDoc::Context < RDoc::CodeObject
   # Adds +constant+ if not already there. If it is, updates the comment,
   # value and/or is_alias_for of the known constant if they were empty/nil.
 
-  def add_constant constant
+  def add_constant(constant)
     return constant unless @document_self
 
     # HACK: avoid duplicate 'PI' & 'E' in math.c (1.8.7 source code)
@@ -451,7 +451,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Adds included module +include+ which should be an RDoc::Include
 
-  def add_include include
+  def add_include(include)
     add_to @includes, include
 
     include
@@ -460,7 +460,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Adds extension module +ext+ which should be an RDoc::Extend
 
-  def add_extend ext
+  def add_extend(ext)
     add_to @extends, ext
 
     ext
@@ -470,7 +470,7 @@ class RDoc::Context < RDoc::CodeObject
   # Adds +method+ if not already there. If it is (as method or attribute),
   # updates the comment if it was empty.
 
-  def add_method method
+  def add_method(method)
     return method unless @document_self
 
     # HACK: avoid duplicate 'new' in io.c & struct.c (1.8.7 source code)
@@ -524,7 +524,7 @@ class RDoc::Context < RDoc::CodeObject
   # Adds an alias from +from+ (a class or module) to +name+ which was defined
   # in +file+.
 
-  def add_module_alias from, from_name, to, file
+  def add_module_alias(from, from_name, to, file)
     return from if @done_documenting
 
     to_full_name = child_name to.name
@@ -583,7 +583,7 @@ class RDoc::Context < RDoc::CodeObject
   #
   # See also RDoc::Context::Section
 
-  def add_section title, comment = nil
+  def add_section(title, comment = nil)
     if section = @sections[title] then
       section.add_comment comment if comment
     else
@@ -597,7 +597,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Adds +thing+ to the collection +array+
 
-  def add_to array, thing
+  def add_to(array, thing)
     array << thing if @document_self
 
     thing.parent  = self
@@ -629,7 +629,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Creates the full name for a child with +name+
 
-  def child_name name
+  def child_name(name)
     if name =~ /^:+/
       $'  #'
     elsif RDoc::TopLevel === self then
@@ -970,7 +970,7 @@ class RDoc::Context < RDoc::CodeObject
   # If +section+ is provided only methods in that RDoc::Context::Section will
   # be returned.
 
-  def methods_by_type section = nil
+  def methods_by_type(section = nil)
     methods = {}
 
     TYPES.each do |type|
@@ -1062,7 +1062,7 @@ class RDoc::Context < RDoc::CodeObject
   #--
   # TODO mark the visibility of attributes in the template (if not public?)
 
-  def remove_invisible min_visibility
+  def remove_invisible(min_visibility)
     return if [:private, :nodoc].include? min_visibility
     remove_invisible_in @method_list, min_visibility
     remove_invisible_in @attributes, min_visibility
@@ -1072,7 +1072,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Only called when min_visibility == :public or :private
 
-  def remove_invisible_in array, min_visibility # :nodoc:
+  def remove_invisible_in(array, min_visibility) # :nodoc:
     if min_visibility == :public then
       array.reject! { |e|
         e.visibility != :public and not e.force_documentation
@@ -1088,7 +1088,7 @@ class RDoc::Context < RDoc::CodeObject
   # Tries to resolve unmatched aliases when a method or attribute has just
   # been added.
 
-  def resolve_aliases added
+  def resolve_aliases(added)
     # resolve any pending unmatched aliases
     key = added.pretty_name
     unmatched_alias_list = @unmatched_alias_lists[key]
@@ -1139,7 +1139,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Sets the current section to a section with +title+.  See also #add_section
 
-  def set_current_section title, comment
+  def set_current_section(title, comment)
     @current_section = add_section title, comment
   end
 
@@ -1204,7 +1204,7 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # Upgrades NormalModule +mod+ in +enclosing+ to a +class_type+
 
-  def upgrade_to_class mod, class_type, enclosing
+  def upgrade_to_class(mod, class_type, enclosing)
     enclosing.modules_hash.delete mod.name
 
     klass = RDoc::ClassModule.from_module class_type, mod

data/lib/rdoc/code_object/method_attr.rb

@@ -91,7 +91,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
   ##
   # Resets cached data for the object so it can be rebuilt by accessor methods
 
-  def initialize_copy other # :nodoc:
+  def initialize_copy(other) # :nodoc:
     @full_name = nil
   end
 
@@ -111,7 +111,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
     [other.singleton ? 0 : 1, other.name_ord_range, other.name]
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     equal?(other) or self.class == other.class and full_name == other.full_name
   end
 
@@ -150,7 +150,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
   ##
   # Sets the store for this class or module and its contained code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @file = @store.add_file @file.full_name if @file
@@ -168,7 +168,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
     return find_method_or_attribute name[0..-2]
   end
 
-  def find_method_or_attribute name # :nodoc:
+  def find_method_or_attribute(name) # :nodoc:
     return nil unless parent.respond_to? :ancestors
 
     searched = parent.ancestors
@@ -282,7 +282,8 @@ class RDoc::MethodAttr < RDoc::CodeObject
   # HTML id-friendly method/attribute name
 
   def html_name
-    require 'cgi/util'
+    require 'cgi/escape'
+    require 'cgi/util' unless defined?(CGI::EscapeExt)
 
     CGI.escape(@name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
   end
@@ -341,7 +342,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
     @parent_name || super
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     alias_for =
       if @is_alias_for.respond_to? :name then
         "alias for #{@is_alias_for.name}"

data/lib/rdoc/code_object/mixin.rb

@@ -23,13 +23,13 @@ class RDoc::Mixin < RDoc::CodeObject
   ##
   # Mixins are sorted by name
 
-  def <=> other
+  def <=>(other)
     return unless self.class === other
 
     name <=> other.name
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other and @name == other.name
   end
 
@@ -107,7 +107,7 @@ class RDoc::Mixin < RDoc::CodeObject
   ##
   # Sets the store for this class or module and its contained code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @file = @store.add_file @file.full_name if @file

data/lib/rdoc/code_object/normal_class.rb

@@ -53,7 +53,7 @@ class RDoc::NormalClass < RDoc::ClassModule
     display
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     superclass = @superclass ? " < #{@superclass}" : nil
 
     q.group 2, "[class #{full_name}#{superclass}", "]" do

data/lib/rdoc/code_object/normal_module.rb

@@ -29,7 +29,7 @@ class RDoc::NormalModule < RDoc::ClassModule
     true
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[module #{full_name}:", "]" do
       q.breakable
       q.text "includes:"

data/lib/rdoc/code_object/single_class.rb

@@ -22,7 +22,7 @@ class RDoc::SingleClass < RDoc::ClassModule
     "class << #{full_name}"
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[class << #{full_name}", "]" do
       next
     end

data/lib/rdoc/code_object/top_level.rb

@@ -33,7 +33,7 @@ class RDoc::TopLevel < RDoc::Context
   # is being generated outside the source dir +relative_name+ is relative to
   # the source directory.
 
-  def initialize absolute_name, relative_name = absolute_name
+  def initialize(absolute_name, relative_name = absolute_name)
     super()
     @name = nil
     @absolute_name = absolute_name
@@ -55,7 +55,7 @@ class RDoc::TopLevel < RDoc::Context
   ##
   # An RDoc::TopLevel is equal to another with the same relative_name
 
-  def == other
+  def ==(other)
     self.class === other and @relative_name == other.relative_name
   end
 
@@ -73,7 +73,7 @@ class RDoc::TopLevel < RDoc::Context
   ##
   # Adds +constant+ to +Object+ instead of +self+.
 
-  def add_constant constant
+  def add_constant(constant)
     object_class.record_location self
     return constant unless @document_self
     object_class.add_constant constant
@@ -101,7 +101,7 @@ class RDoc::TopLevel < RDoc::Context
   # Adds class or module +mod+. Used in the building phase
   # by the Ruby parser.
 
-  def add_to_classes_or_modules mod
+  def add_to_classes_or_modules(mod)
     @classes_or_modules << mod
   end
 
@@ -128,7 +128,7 @@ class RDoc::TopLevel < RDoc::Context
   # TODO Why do we search through all classes/modules found, not just the
   #       ones of this instance?
 
-  def find_class_or_module name
+  def find_class_or_module(name)
     @store.find_class_or_module name
   end
 
@@ -192,7 +192,7 @@ class RDoc::TopLevel < RDoc::Context
   ##
   # Loads this TopLevel from +array+.
 
-  def marshal_load array # :nodoc:
+  def marshal_load(array) # :nodoc:
     initialize array[1]
 
     @parser  = array[2]
@@ -231,7 +231,7 @@ class RDoc::TopLevel < RDoc::Context
     File.join(prefix, http_url)
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[#{self.class}: ", "]" do
       q.text "base name: #{base_name.inspect}"
       q.breakable