method

filter

Ruby latest stable (v2_5_5) - 0 notes - Class: PerlPOD

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
1_9_3_392
2_1_10
2_2_9
2_4_6
2_5_5
2_6_3
What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v1_9_2_180) is shown here.

These similar methods exist in v2_5_5:

URI::LDAP#filter
REXML::QuickPath#filter
CSV#filter

filter(comment) public

Filter the perl markup that does the same as the rdoc filtering. Only basic for now. Will probably need a proper parser to cope with C<<…>> etc

Show source

# File lib/rdoc/parser/perl.rb, line 151
  def filter(comment)
    return '' if comment =~ /^=pod\s*$/
    comment.gsub!(/^=pod/, '==')
    comment.gsub!(/^=head(\d+)/) do
      "=" * $1.to_i
    end
    comment.gsub!(/=item/, '');
    comment.gsub!(/C<(.*?)>/, '<tt>\1</tt>');
    comment.gsub!(/I<(.*?)>/, '<i>\1</i>');
    comment.gsub!(/B<(.*?)>/, '<b>\1</b>');
    comment
  end

filter

Related methods

Method deprecated or moved

Flowdock - Team Inbox With Chat