Ruby 2.2.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/markup/formatterライブラリ > RDoc::Markup::Formatterクラス

class RDoc::Markup::Formatter

クラス・モジュールの継承リスト: RDoc::Markup::Formatter < Object < Kernel < BasicObject

要約

RDoc 形式のドキュメントを整形するための基本クラスです。

実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、継承したクラスで convert メソッドを実行してください。

特異メソッド

定義 説明
new(markup = nil) -> RDoc::Markup::Formatter

自身を初期化します。

インスタンスメソッド

定義 説明
add_tag(name, start, stop) -> ()

name で登録された規則で取得された文字列を start と stop で囲むように指定します。

convert(content) -> ()

content で指定された文字列を変換します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE