ライブラリ:rdoc > クエリ:RDoc > バージョン:3.0

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

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

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

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

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

インスタンスメソッド

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

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

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

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

RDoc::Markup#add_html(tag, name) -> () (9040.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#add_special(pattern, name) -> () (9040.0)

インスタンスメソッド

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

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'

class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"<font color=red>" +...

絞り込み条件を変える

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

インスタンスメソッド

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

...ます。

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:S...

RDoc::Parser#parse_files_matching(regexp) -> () (9040.0)

インスタンスメソッド

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、自身を登録します。

...マッチするファイルを解析できるパーサとして、
自身を登録します。

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

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end...

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self...

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children...

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent...

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent...

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

インスタンスメソッド

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

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

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

RDoc::Context::Section#==(other) -> bool (9022.0)

インスタンスメソッド

自身と other のシーケンス番号を比較した結果を返します。

...自身と other のシーケンス番号を比較した結果を返します。

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

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

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see SM::SimpleMarkup#convert...

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

インスタンスメソッド

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

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

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

RDoc::Options#verbosity=(val) (9022.0)

インスタンスメソッド

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

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

@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。

@see RDoc::Options#verbosity...

RDoc::Error (9007.0)

クラス

ドキュメントの処理中にエラーがあった場合に発生します。

RDoc::Alias (9004.0)

クラス

aliasされたメソッドを表現するクラスです。

aliasされたメソッドを表現するクラスです。

ライブラリの内部で使用します。

絞り込み条件を変える

RDoc::AnonClass (9004.0)

クラス

匿名クラスを表現するクラスです。

匿名クラスを表現するクラスです。

現在は使用されていません。

RDoc::AnyMethod (9004.0)

クラス

メソッドを表現するクラスの基本クラスです。

メソッドを表現するクラスの基本クラスです。

ライブラリの内部で使用します。

RDoc::Attr (9004.0)

クラス

属性を表現するクラスです。

属性を表現するクラスです。

ライブラリの内部で使用します。

RDoc::ClassModule (9004.0)

クラス

クラスやモジュールを表現するための基本クラスです。

クラスやモジュールを表現するための基本クラスです。

ライブラリの内部で使用します。

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

RDoc::Constant (9004.0)

クラス

定数を表現するクラスです。

定数を表現するクラスです。

ライブラリの内部で使用します。

RDoc::Context#<=>(other) -> -1 | 0 | 1 (9004.0)

インスタンスメソッド

自身と other の full_name を比較した結果を返します。

自身と other の full_name を比較した結果を返します。

ソートのために使われます。

@param other 自身と比較したいオブジェクトを指定します。

絞り込み条件を変える

RDoc::Context#defined_in?(file) (9004.0)

インスタンスメソッド

Return true if at least part of this thing was defined in file

RDoc::Context#find_local_symbol(symbol) (9004.0)

インスタンスメソッド

Finds a method, constant, attribute, module or files named +symbol+ in this context

Finds a method, constant, attribute, module or files named +symbol+ in
this context

RDoc::Context#find_symbol(symbol, method=nil) (9004.0)

インスタンスメソッド

Look up the given symbol. If method is non-nil, then we assume the symbol references a module that contains that method

Look up the given symbol. If method is non-nil, then we assume
the symbol references a module that contains that method

RDoc::Context#in_files (9004.0)

インスタンスメソッド

Files this context is found in

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

RDoc::Context#name -> String (9004.0)

インスタンスメソッド

自身の名前を返します。

自身の名前を返します。

サブクラスによっては、メソッド名やクラス名を意味します。

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

インスタンスメソッド

Change the default visibility for new methods

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

インスタンスメソッド

Record the file that we happen to find it in

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

インスタンスメソッド

Handle sections

絞り込み条件を変える

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

インスタンスメソッド

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

RDoc::Context::Section (9004.0)

クラス

section に関する情報を保持するクラスです。

section に関する情報を保持するクラスです。

ドキュメント中で以下のように記述した情報を保持しています。

# :section: The title
# The body

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

インスタンスメソッド

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

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

インスタンスメソッド

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

RDoc::Context::Section#sequence -> String (9004.0)

インスタンスメソッド

section のシーケンス番号を文字列で返します。

section のシーケンス番号を文字列で返します。

リンクを作成する時に使われます。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

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

インスタンスメソッド

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

RDoc::Context::TYPES -> ["class", "instance"] (9004.0)

定数

メソッドの種類を文字列の配列で返します。

RDoc::Context::VISIBILITIES -> [:public, :protected, :private] (9004.0)

定数

メソッドの可視性を Symbol の配列で返します。

RDoc::Generator::Darkfish (9004.0)

クラス

HTML を生成するためのクラスです。

絞り込み条件を変える

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

インスタンスメソッド

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

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (9004.0)

定数

このファイルの親ディレクトリへのパスを表す文字列です。

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

RDoc::Generator::Darkfish::VERSION -> '3' (9004.0)

定数

darkfish のバージョンです。

RDoc::Generator::JsonIndex (9004.0)

クラス

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデックスを生成するクラスです。

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。

RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE -> String (9004.0)

定数

検索インデックスのパスを表す文字列です。

絞り込み条件を変える

RDoc::Generator::Markup (9004.0)

モジュール

ライブラリ内部で使用します。

RDoc::Generator::RI (9004.0)

クラス

ri のためのファイルを生成するためのクラスです。

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

インスタンスメソッド

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

RDoc::Generator::RI::DESCRIPTION -> String (9004.0)

定数

このジェネレータの説明を表す文字列です。

RDoc::GhostMethod (9004.0)

クラス

コメントでのみ参照されるメソッドを表現します。

コメントでのみ参照されるメソッドを表現します。

ライブラリの内部で使用します。

絞り込み条件を変える

RDoc::Include (9004.0)

クラス

includeされるファイルを表現します。

includeされるファイルを表現します。

ライブラリの内部で使用します。

RDoc::Markdown#break_on_newline -> bool (9004.0)

インスタンスメソッド

改行を保持した状態で出力するかどうかを返します。

改行を保持した状態で出力するかどうかを返します。

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

RDoc::Markdown#break_on_newline=(val) (9004.0)

インスタンスメソッド

改行を保持した状態で出力するかどうかを設定します。

RDoc::Markdown#css -> bool (9004.0)

インスタンスメソッド

CSS を記述した場合に出力に含めるかどうかを返します。

CSS を記述した場合に出力に含めるかどうかを返します。

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

RDoc::Markdown#css=(val) (9004.0)

インスタンスメソッド

CSS を記述した場合に出力に含めるかどうかを設定します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

絞り込み条件を変える

RDoc::Markdown.extension(name) -> nil (9004.0)

特異メソッド

引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定義します。

引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。

ライブラリ内部で使用します。

RDoc::Markdown::DEFAULT_EXTENSIONS -> [Symbol] (9004.0)

定数

デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。

RDoc::Markdown::EXTENSIONS -> [Symbol] (9004.0)

定数

サポートする拡張の一覧を Symbol の配列で返します。

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

インスタンスメソッド

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

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

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

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

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

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