method

find_modifiers

v1_9_3_392 - Show latest stable - 0 notes - Class: C

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378 (0)
1_9_2_180 (0)
1_9_3_125 (37)
1_9_3_392 (0)
2_1_10 (-38)
2_2_9 (0)
2_4_6
2_5_5
2_6_3
What's this?

find_modifiers(comment, meth_obj) public

Handles modifiers in comment and updates meth_obj as appropriate.

If :nodoc: is found, documentation on meth_obj is suppressed.

If :yields: is followed by an argument list it is used for the #block_params of meth_obj.

If the comment block contains a <tt>

call-seq:
   ARGF.readlines(sep=$/)     -> array
   ARGF.readlines(limit)      -> array
   ARGF.readlines(sep, limit) -> array

   ARGF.to_a(sep=$/)     -> array
   ARGF.to_a(limit)      -> array
   ARGF.to_a(sep, limit) -> array

it is used for the parameters of meth_obj.

Show source

# File lib/rdoc/parser/c.rb, line 613
  def find_modifiers comment, meth_obj
    # we must handle situations like the above followed by an unindented first
    # comment.  The difficulty is to make sure not to match lines starting
    # with ARGF at the same indent, but that are after the first description
    # paragraph.

    if comment =~ /call-seq:(.*?(?:\S|\*\/?).*?)^\s*(?:\*\/?)?\s*$/ then
      all_start, all_stop = $~.offset(0)
      seq_start, seq_stop = $~.offset(1)

      # we get the following lines that start with the leading word at the
      # same indent, even if they have blank lines before
      if $1 =~ /(^\s*\*?\s*\n)+^(\s*\*?\s*\w+)/ then
        leading = $2 # ' *    ARGF' in the example above
        re = %
          \A(
             (^\s*\*?\s*\n)+
             (^#{Regexp.escape leading}.*?\n)+
            )+
          ^\s*\*?\s*$
        %m
        if comment[seq_stop..-1] =~ re then
          all_stop = seq_stop + $~.offset(0).last
          seq_stop = seq_stop + $~.offset(1).last
        end
      end

      seq = comment[seq_start..seq_stop]
      seq.gsub!(/^(\s*\*?\s*?)(\S|\n)/, '\2')
      comment.slice! all_start...all_stop
      meth_obj.call_seq = seq
    elsif comment.sub!(/\A\/\*\s*call-seq:(.*?)\*\/\Z/, '') then
      meth_obj.call_seq = $1.strip
    end

    look_for_directives_in meth_obj, comment
  end

find_modifiers

Related methods