るりまサーチ (Ruby 2.3.0)

最速Rubyリファレンスマニュアル検索!
14件ヒット [1-14件を表示] (0.041秒)

別のキーワード

  1. markup new
  2. text markup
  3. markup space
  4. markup content
  5. markup convert

モジュール

キーワード

検索結果

RDoc::Options#markup -> String (54355.0)

コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。

コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

指定されていない場合は 'rdoc' を返します。

RDoc::Text#markup(text) -> String (54307.0)

引数を整形します。

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

@param text 文字列を指定します。

RDoc::Options#markup=(val) (18355.0)

コマンドライン引数の --markup オプションと同様の指定を行います。

コマンドライン引数の --markup オプションと同様の指定を行います。

@param val フォーマットを文字列で指定します。

RDoc::Markup#add_html(tag, name) -> () (9076.0)

tag で指定したタグをフォーマットの対象にします。

tag で指定したタグをフォーマットの対象にします。

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht...

RDoc::Markup#add_special(pattern, name) -> () (9076.0)

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

@param pattern 正規表現を指定します。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require '...

絞り込み条件を変える

RDoc::Markup#add_word_pair(start, stop, name) -> () (9076.0)

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/...

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (9058.0)

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

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

@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup:...

RDoc::Markup#attribute_manager -> RDoc::AttributeManager (9004.0)

自身の RDoc::AttributeManager オブジェクトを返します。

自身の RDoc::AttributeManager オブジェクトを返します。

RDoc::Markup#content -> String (9004.0)

変換する文字列を返します。

変換する文字列を返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。

@see SM::SimpleMarkup#convert

RDoc::Markup#convert(str, formatter) -> object | "" (9004.0)

str で指定された文字列を formatter に変換させます。

str で指定された文字列を formatter に変換させます。

@param str 変換する文字列を指定します。

@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。

変換結果は formatter によって文字列や配列を返します。

絞り込み条件を変える

RDoc::Markup#get_line_types -> [Symbol] (9004.0)

変換する文字列の各行のタイプを Symbol の配列で返します。

変換する文字列の各行のタイプを Symbol の配列で返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

@see SM::SimpleMarkup#convert

RDoc::Markup::Formatter#convert(content) -> () (9004.0)

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

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

@param content 変換する文字列を指定します。

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (355.0)

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (307.0)

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

@param text 文字列を指定します。

@see RDoc::Text#normalize_comment