るりまサーチ (Ruby 2.4.0)

最速Rubyリファレンスマニュアル検索！
418件ヒット [201-300件を表示] （0.070秒）
トップページ > バージョン:2.4.0[x] > クエリ:rdoc[x]

別のキーワード

  1. rdoc version
  2. rdoc/context new
  3. rdoc/markdown parse
  4. rdoc attr_modifiers
  5. rdoc class_modifiers

種類

ライブラリ

クラス

モジュール

オブジェクト

キーワード

検索結果

先頭5件

  1. RDoc::CodeObject#parent=(val)
  2. RDoc::CodeObject#parent_file_name -> String
  3. RDoc::CodeObject#parent_name -> String
  4. RDoc::CodeObject#section=(val)
  5. RDoc::Context::Section#==(other) -> bool
<< < 1 2 3 4 5 > >>

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

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

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

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

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

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

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

@see RDoc::CodeObject#parent

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

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

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

@see RDoc::CodeObject#parent

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

@see SM::SimpleMarkup#convert

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

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

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

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

@see SM::SimpleMarkup#convert

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

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

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

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

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

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

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

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

@see RDoc::Options#verbosity

RDoc::Alias (9001.0)

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

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


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

絞り込み条件を変える

RDoc::AnonClass (9001.0)

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

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

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

RDoc::AnyMethod (9001.0)

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

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

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

RDoc::Attr (9001.0)

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

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

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

RDoc::ClassModule (9001.0)

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

RDoc::Constant (9001.0)

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

RDoc::Context#find_local_symbol(symbol) (9001.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) (9001.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 (9001.0)

Files this context is found in

Files this context is found in

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

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

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

絞り込み条件を変える

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

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

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

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

自身の名前を返します。

自身の名前を返します。

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

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

Change the default visibility for new methods

Change the default visibility for new methods

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

Record the file that we happen to find it in

Record the file that we happen to find it in

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

Handle sections

Handle sections

絞り込み条件を変える

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

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

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

RDoc::Context::Section (9001.0)

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

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

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

# :section: The title
# The body

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Generator::Darkfish (9001.0)

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

RDoc::Generator::Darkfish::VERSION -> &#39;3&#39; (9001.0)

darkfish のバージョンです。

darkfish のバージョンです。

RDoc::Generator::JsonIndex (9001.0)

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

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

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

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

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

絞り込み条件を変える

RDoc::Generator::Markup (9001.0)

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

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

RDoc::Generator::RI (9001.0)

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

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

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

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

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

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

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

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

RDoc::GhostMethod (9001.0)

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

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

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

絞り込み条件を変える

RDoc::Include (9001.0)

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Markup::LABEL_LIST_RE -> Regexp (9001.0)

ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。

ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。

RDoc::Markup::SIMPLE_LIST_RE -> Regexp (9001.0)

リストにマッチする正規表現です。ライブラリの内部で使用します。

リストにマッチする正規表現です。ライブラリの内部で使用します。

ラベルの有無を問わずマッチします。

RDoc::Markup::SPACE -> ?\s (9001.0)

空白文字です。?\s を返します。ライブラリの内部で使用します。

空白文字です。?\s を返します。ライブラリの内部で使用します。

RDoc::MetaMethod (9001.0)

動的に定義されたメソッドを表現するクラスです。

動的に定義されたメソッドを表現するクラスです。

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

RDoc::NormalClass (9001.0)

クラスを表現するためのクラスです。

クラスを表現するためのクラスです。

特異クラスや匿名クラスは含まれません。

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

絞り込み条件を変える

RDoc::NormalModule (9001.0)

モジュールを表現するクラスです。

モジュールを表現するクラスです。

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

RDoc::Options#all_one_file -> bool (9001.0)

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Options#css -> String (9001.0)

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

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

RDoc::Options#diagram -> bool (9001.0)

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

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

RDoc::Options#dry_run -> bool (9001.0)

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

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

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

RDoc::Options#dry_run=(val) (9001.0)

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

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

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

RDoc::Options#encoding -> Encoding (9001.0)

コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。

コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。

指定しなかった場合は Encoding.default_external の値を返します。

絞り込み条件を変える

RDoc::Options#encoding=(val) (9001.0)

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

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

@param val 設定する Encoding オブジェクトを指定します。

RDoc::Options#exclude -> Regexp (9001.0)

コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。

コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。

RDoc::Options#exclude=(val) (9001.0)

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

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

@param val 設定するパターンを Regexp オブジェクトで指定します。

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

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

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

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

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

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

絞り込み条件を変える

RDoc::Options#fileboxes -> bool (9001.0)

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

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

RDoc::Options#files -> [String] (9001.0)

解析するファイルの一覧を文字列の配列で返します。

解析するファイルの一覧を文字列の配列で返します。

RDoc::Options#finish_page_dir (9001.0)

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

使用されていません。

使用されていません。

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

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

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

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

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

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

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

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

絞り込み条件を変える

<< < 1 2 3 4 5 > >>

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 13.0.0 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。