クエリ:t > ライブラリ:rdoc > 種類:インスタンスメソッド > バージョン:3.0

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

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

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

例:

require 'rdoc/markup/to_html...

...'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")...

RDoc::Options#generator -> Generator (18607.0)

インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

RDoc::Text#strip_hashes(text) -> String (18607.0)

インスタンスメソッド

引数から各行の行頭の # を削除します。

引数から各行の行頭の # を削除します。

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

RDoc::Text#strip_newlines(text) -> String (18607.0)

インスタンスメソッド

引数から先頭と末尾の改行を削除します。

引数から先頭と末尾の改行を削除します。

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

RDoc::Text#strip_stars(text) -> String (18607.0)

インスタンスメソッド

引数から /* 〜 */ 形式のコメントを削除します。

引数から /* 〜 */ 形式のコメントを削除します。

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

絞り込み条件を変える

RDoc::TopLevel#file_stat -> File::Stat (18607.0)

インスタンスメソッド

自身が管理するファイルに関する File::Stat オブジェクトを返します。

RDoc::Text#expand_tabs(text) -> String (18355.0)

インスタンスメソッド

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースになるように置き換えます。

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。

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

RDoc::CodeObject#comment -> String (18307.0)

インスタンスメソッド

自身のコメントを返します。

RDoc::CodeObject#comment=(comment) (18307.0)

インスタンスメソッド

自身のコメントを comment に設定します。

自身のコメントを comment に設定します。

ただし、comment が空文字列だった場合は何もしません。

@param comment コメントを文字列で指定します。

RDoc::CodeObject#document_children -> bool (18307.0)

インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを返します。

...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self...

絞り込み条件を変える

RDoc::CodeObject#document_children=(val) (18307.0)

インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを設定します。

...トに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules...

RDoc::CodeObject#document_self -> bool (18307.0)

インスタンスメソッド

自身をドキュメントに含めるかどうかを返します。

...自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children...

RDoc::CodeObject#document_self=(val) (18307.0)

インスタンスメソッド

自身をドキュメントに含めるかどうかを設定します。

...c: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc...

RDoc::CodeObject#documented? -> bool (18307.0)

インスタンスメソッド

出力すべきドキュメントがあるかどうかを返します。

RDoc::CodeObject#parent=(val) (18307.0)

インスタンスメソッド

自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

...自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

@param val RDoc::CodeObject のサブクラスのオブジェクトを指定しま
す。...

絞り込み条件を変える

RDoc::CodeObject#parent_file_name -> String (18307.0)

インスタンスメソッド

self.parent のファイル名を返します。

...self.parent のファイル名を返します。

@see RDoc::CodeObject#parent...

RDoc::CodeObject#parent_name -> String (18307.0)

インスタンスメソッド

self.parent の名前を返します。

...self.parent の名前を返します。

@see RDoc::CodeObject#parent...

RDoc::CodeObject#remove_methods_etc -> () (18307.0)

インスタンスメソッド

何もしません。RDoc::CodeObject#document_self= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。

...何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。...

RDoc::CodeObject#section=(val) (18307.0)

インスタンスメソッド

所属する section を設定します。

...所属する section を設定します。

@param val RDoc::Context::Section オブジェクトを指定します。...

RDoc::CodeObject#start_doc -> () (18307.0)

インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまでの間、ドキュメントに含めます。

...たコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_d...

絞り込み条件を変える

RDoc::CodeObject#stop_doc -> () (18307.0)

インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すまでの間、ドキュメントに含めません。

...コメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。

:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。

@see RDoc::CodeObject#star...

RDoc::Context#add_constant(const) -> () (18307.0)

インスタンスメソッド

引数で指定した RDoc::Constant オブジェクトを追加します。

...引数で指定した RDoc::Constant オブジェクトを追加します。

@param const RDoc::Constant オブジェクトを指定します。...

RDoc::Context#add_to(array, thing) -> () (18307.0)

インスタンスメソッド

array に thing を追加します。

...を指定します。

RDoc::Context#add_alias などで使われています。ライブラリ内部で使
用します。

@see RDoc::Context#add_alias, RDoc::Context#add_attribute,
RDoc::Context#add_constant, RDoc::Context#add_include,
RDoc::Context#add_method, RDoc::Context#add_require...

RDoc::Context#current_section -> RDoc::Context::Section (18307.0)

インスタンスメソッド

現在の section を返します。

RDoc::Context#initialize_classes_and_modules -> () (18307.0)

インスタンスメソッド

追加されたクラスやモジュールをクリアします。

絞り込み条件を変える

RDoc::Context#initialize_methods_etc -> () (18307.0)

インスタンスメソッド

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れていないものを含む)、require されたファイル、include されたファイル、定数をクリアします。

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。

RDoc::Context#ongoing_visibility=(vis) (18307.0)

インスタンスメソッド

Change the default visibility for new methods

RDoc::Context#record_location(toplevel) (18307.0)

インスタンスメソッド

Record the file that we happen to find it in

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (18307.0)

インスタンスメソッド

methods で指定した RDoc::AnyMethod、RDoc::Attr の内、 singleton で指定した条件と一致するメソッドすべての可視性を visibility に設定します。

...methods で指定した RDoc::AnyMethod、RDoc::Attr の内、
singleton で指定した条件と一致するメソッドすべての可視性を visibility
に設定します。

@param methods RDoc::AnyMethod、RDoc::Attr オブジェクトの配
列を指定します。

@param vi...

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (18307.0)

インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。...

絞り込み条件を変える

RDoc::Context#unmatched_alias_lists=(val) (18307.0)

インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。

...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。

@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。...

RDoc::Context#visibility -> :public | :protected | :private (18307.0)

インスタンスメソッド

自身の可視性を Symbol で返します。

RDoc::Context::Section#comment -> String | nil (18307.0)

インスタンスメソッド

section のコメントを返します。

RDoc::Context::Section#inspect -> String (18307.0)

インスタンスメソッド

自身の情報を人間に読みやすい文字列にして返します。

RDoc::Context::Section#set_comment(comment) -> () (18307.0)

インスタンスメソッド

自身にコメントを設定します。

自身にコメントを設定します。

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

comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。

# ---------------------
# :section: The title
# The body
# ---------------------

絞り込み条件を変える

RDoc::Context::Section#title -> String | nil (18307.0)

インスタンスメソッド

section のタイトルを返します。

RDoc::Generator::Darkfish#generate -> () (18307.0)

インスタンスメソッド

解析した情報を HTML ファイルや検索用のインデックスに出力します。

RDoc::Generator::JsonIndex#generate -> () (18307.0)

インスタンスメソッド

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出力します。

...解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。...

RDoc::Generator::RI#generate -> () (18307.0)

インスタンスメソッド

解析した情報を ri コマンドから読めるようにファイルに出力します。

RDoc::Markdown#definition_lists -> bool (18307.0)

インスタンスメソッド

定義リストを解釈するかどうかを返します。

定義リストを解釈するかどうかを返します。

デフォルトでは true を返します。

絞り込み条件を変える

RDoc::Markdown#definition_lists=(val) (18307.0)

インスタンスメソッド

定義リストを解釈するかどうかを設定します。

RDoc::Markdown#extension(name, enable) -> () (18307.0)

インスタンスメソッド

引数 name で指定した拡張の有効/無効を設定します。

引数 name で指定した拡張の有効/無効を設定します。

@param name 拡張の名前を Symbol で指定します。

@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。

RDoc::Markdown#extension?(name) (18307.0)

インスタンスメソッド

引数 name で指定した拡張が有効かどうかを返します。

引数 name で指定した拡張が有効かどうかを返します。

@param name 拡張の名前を Symbol で指定します。

RDoc::Markdown#github -> bool (18307.0)

インスタンスメソッド

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返します。

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。

デフォルトでは true を返します。

RDoc::Markdown#github=(val) (18307.0)

インスタンスメソッド

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定します。

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定
します。

絞り込み条件を変える

RDoc::Markdown#html -> bool (18307.0)

インスタンスメソッド

HTML を記述した場合にそのまま出力するかどうかを返します。

HTML を記述した場合にそのまま出力するかどうかを返します。

デフォルトでは true を返します。

RDoc::Markdown#html=(val) (18307.0)

インスタンスメソッド

HTML を記述した場合にそのまま出力するかどうかを設定します。

RDoc::Markdown#notes -> bool (18307.0)

インスタンスメソッド

脚注の出力を有効にするかどうかを返します。

脚注の出力を有効にするかどうかを返します。

デフォルトでは true を返します。

RDoc::Markdown#notes=(val) (18307.0)

インスタンスメソッド

脚注の出力を有効にするかどうかを設定します。

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

インスタンスメソッド

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

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:STRIKE,...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

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

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

インスタンスメソッド

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

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

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

@see SM::SimpleMarkup#convert...

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

インスタンスメソッド

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

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

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

RDoc::Options#charset -> String (18307.0)

インスタンスメソッド

コマンドライン引数の --charset オプションで指定した文字コードを文字列で返します。

コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。

指定しなかった場合は、$KCODE に応じた値になります。

絞り込み条件を変える

RDoc::Options#coverage_report -> Integer | false (18307.0)

インスタンスメソッド

コマンドライン引数の --coverage-report オプションを指定していた場合、指定した数値を返します。

コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。

指定しなかった場合は false を返します。

RDoc::Options#coverage_report=(val) (18307.0)

インスタンスメソッド

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

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

@param val 数値オブジェクトか false を指定します。

RDoc::Options#extra_accessors -> Regexp | nil (18307.0)

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべてにマッチする正規表現オブジェクトを返します。

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。

指定しなかった場合は nil を返します。

RDoc::Options#force_output -> bool (18307.0)

インスタンスメソッド

コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返します。

コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は true を返します。

RDoc::Options#force_output=(val) (18307.0)

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --force_output オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。

@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

絞り込み条件を変える

RDoc::Options#force_update -> bool (18307.0)

インスタンスメソッド

コマンドライン引数の --force_update を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。

RDoc::Options#formatter -> nil (18307.0)

インスタンスメソッド

使用されていません。常に nil を返します。

RDoc::Options#formatter=(val) (18307.0)

インスタンスメソッド

使用されていません。

RDoc::Options#generator=(val) (18307.0)

インスタンスメソッド

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

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

@param val 設定する Generator を指定します。

RDoc::Options#image_format -> String (18307.0)

インスタンスメソッド

コマンドライン引数の --image-format オプションで指定した名前を文字列の配列で返します。

コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。

指定しなかった場合は 'png' を返します。

絞り込み条件を変える

RDoc::Options#quiet -> bool (18307.0)

インスタンスメソッド

コマンドライン引数の --quiet オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

RDoc::Options#root -> Pathname (18307.0)

インスタンスメソッド

コマンドライン引数の --root オプションで指定したディレクトリを返します。

コマンドライン引数の --root オプションで指定したディレクトリを返します。

指定されていない場合はカレントディレクトリを返します。

RDoc::Options#root=(val) (18307.0)

インスタンスメソッド

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

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

@param val パスを文字列で指定します。

RDoc::Options#tab_width -> Integer (18307.0)

インスタンスメソッド

コマンドライン引数の --tab-width オプションで指定した数値を返します。

RDoc::Options#verbosity -> 0 | 1 | 2 (18307.0)

インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で返します。

プログラムの解析時に表示する情報の詳細さを数値で返します。

以下の値を指定する事ができます。

: 0(--quiet オプションを指定した場合)

情報を表示しません。

: 1

通常の表示を行います。

: 2(--verbose オプションを指定した場合)

詳細な情報を表示します。

絞り込み条件を変える

<< 1 2 > >>

別のキーワード

クラス

モジュール

キーワード

検索結果

先頭5件

RDoc::CodeObject#metadata -> Hash (27607.0)

RDoc::Context#add_attribute(an_attribute) -> () (27607.0)

RDoc::Context#attributes -> [RDoc::Attr] (27607.0)

RDoc::Context#each_attribute {|a| ... } -> [RDoc::Attr] (27607.0)

RDoc::Context#set_current_section(title, comment) -> () (27607.0)

RDoc::Options#option_parser -> OptionParser | nil (27607.0)

RDoc::Options#template -> String (27607.0)

RDoc::Options#template_dir -> String | nil (27607.0)

RDoc::Options#template_dir=(val) (27607.0)

RDoc::Options#option_parser=(val) (27307.0)

RDoc::Options#sanitize_path(path) (27307.0)

RDoc::Options#static_path -> [String] (27307.0)

RDoc::Options#static_path=(vals) (27307.0)

RDoc::Options#title -> String | nil (27307.0)

RDoc::Options#title=(string) (27307.0)

RDoc::Options#write_options -> object (27307.0)

RDoc::Options#extra_accessor_flags -> {String => String} (18907.0)

RDoc::CodeObject#parent -> RDoc::CodeObject (18607.0)

RDoc::CodeObject#section -> RDoc::Context::Section (18607.0)

RDoc::Context#add_method(a_method) -> () (18607.0)

RDoc::Context#constants -> [RDoc::Constant] (18607.0)

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (18607.0)

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (18607.0)

RDoc::Context#method_list -> [RDoc::AnyMethod] (18607.0)

RDoc::Context#sections -> RDoc::Context::Section (18607.0)

RDoc::Context#toplevel -> RDoc::TopLevel (18607.0)

RDoc::Context::Section#parent -> RDoc::Context (18607.0)

RDoc::Generator::Darkfish#initialize(store, options) -> RDoc::Generator::Darkfish (18607.0)

RDoc::Generator::RI#initialize(store, options) -> RDoc::Generator::RI (18607.0)

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

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

RDoc::Options#generator -> Generator (18607.0)

RDoc::Text#strip_hashes(text) -> String (18607.0)

RDoc::Text#strip_newlines(text) -> String (18607.0)

RDoc::Text#strip_stars(text) -> String (18607.0)

RDoc::TopLevel#file_stat -> File::Stat (18607.0)

RDoc::Text#expand_tabs(text) -> String (18355.0)

RDoc::CodeObject#comment -> String (18307.0)

RDoc::CodeObject#comment=(comment) (18307.0)

RDoc::CodeObject#document_children -> bool (18307.0)

RDoc::CodeObject#document_children=(val) (18307.0)

RDoc::CodeObject#document_self -> bool (18307.0)

RDoc::CodeObject#document_self=(val) (18307.0)

RDoc::CodeObject#documented? -> bool (18307.0)

RDoc::CodeObject#parent=(val) (18307.0)

RDoc::CodeObject#parent_file_name -> String (18307.0)

RDoc::CodeObject#parent_name -> String (18307.0)

RDoc::CodeObject#remove_methods_etc -> () (18307.0)

RDoc::CodeObject#section=(val) (18307.0)

RDoc::CodeObject#start_doc -> () (18307.0)

RDoc::CodeObject#stop_doc -> () (18307.0)

RDoc::Context#add_constant(const) -> () (18307.0)

RDoc::Context#add_to(array, thing) -> () (18307.0)

RDoc::Context#current_section -> RDoc::Context::Section (18307.0)

RDoc::Context#initialize_classes_and_modules -> () (18307.0)

RDoc::Context#initialize_methods_etc -> () (18307.0)

RDoc::Context#ongoing_visibility=(vis) (18307.0)

RDoc::Context#record_location(toplevel) (18307.0)

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (18307.0)

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (18307.0)

RDoc::Context#unmatched_alias_lists=(val) (18307.0)

RDoc::Context#visibility -> :public | :protected | :private (18307.0)

RDoc::Context::Section#comment -> String | nil (18307.0)

RDoc::Context::Section#inspect -> String (18307.0)

RDoc::Context::Section#set_comment(comment) -> () (18307.0)

RDoc::Context::Section#title -> String | nil (18307.0)

RDoc::Generator::Darkfish#generate -> () (18307.0)

RDoc::Generator::JsonIndex#generate -> () (18307.0)

RDoc::Generator::RI#generate -> () (18307.0)

RDoc::Markdown#definition_lists -> bool (18307.0)

RDoc::Markdown#definition_lists=(val) (18307.0)

RDoc::Markdown#extension(name, enable) -> () (18307.0)

RDoc::Markdown#extension?(name) (18307.0)

RDoc::Markdown#github -> bool (18307.0)