るりまサーチ (Ruby 3.1)

最速Rubyリファレンスマニュアル検索！
81件ヒット [1-81件を表示] （0.045秒）
トップページ > クエリ:v[x] > ライブラリ:rdoc[x] > バージョン:3.1[x]

別のキーワード

  1. socket ai_v4mapped
  2. socket ipv6_v6only
  3. socket ai_v4mapped_cfg
  4. _builtin grep_v
  5. etc cs_v6_env

種類

クラス

モジュール

キーワード

検索結果

先頭5件

  1. RDoc::TopLevel#file_relative_name -> String
  2. RDoc::TopLevel#file_relative_name=(val)
  3. RDoc::Context#ongoing_visibility=(vis)
  4. RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> ()
  5. RDoc::Context#toplevel -> RDoc::TopLevel

RDoc::TopLevel#file_relative_name -> String (27304.0)

自身が管理するファイルに関する相対パスを文字列で返します。

自身が管理するファイルに関する相対パスを文字列で返します。

RDoc::TopLevel#file_relative_name=(val) (27304.0)

自身が管理するファイルに関する相対パスを文字列で設定します。

自身が管理するファイルに関する相対パスを文字列で設定します。

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

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

Change the default visibility for new methods

Change the default visibility for new methods

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (18604.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#toplevel -> RDoc::TopLevel (18604.0)

自身が所属する RDoc::TopLevel オブジェクトを返します。

...自身が所属する RDoc::TopLevel オブジェクトを返します。...

絞り込み条件を変える

RDoc::VERSION -> String (18307.0)

RDoc のバージョンを表す文字列を返します。

...
RDoc のバージョンを表す文字列を返します。...

RDoc::CodeObject#remove_classes_and_modules -> () (18304.0)

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

darkfish のバージョンです。

darkfish のバージョンです。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

情報を表示しません。

: 1

通常の表示を行います。

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

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

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

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

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

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

@see RDoc::Options#verbosity...

RDoc::Options#visibility -> :public | :protected | :private (18304.0)

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

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

RDoc::Options#visibility=(val) (18304.0)

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

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

@param val :public、:protected、:private のいずれかを指定します。

RDoc::Options#webcvs -> String | nil (18304.0)

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

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

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

絞り込み条件を変える

RDoc::Parser::Simple#remove_private_comments(comment) -> String (18304.0)

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。

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

@return コメントが削除された文字列を返します。

RDoc::TopLevel (18004.0)

最上位のコンテキスト(ソースファイル)を表現するクラスです。

最上位のコンテキスト(ソースファイル)を表現するクラスです。

RDoc::TopLevel#file_absolute_name=(val) (9304.0)

自身が管理するファイルに関する絶対パスを文字列で設定します。

自身が管理するファイルに関する絶対パスを文字列で設定します。

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

RDoc::TopLevel#file_stat=(val) (9304.0)

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

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

@param val File::Stat オブジェクトを指定します。

RDoc::TopLevel.new(file_name) -> RDoc::TopLevel (9304.0)

自身を初期化します。

自身を初期化します。

@param file_name ファイル名を文字列で指定します。

絞り込み条件を変える

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (9004.0)

collection に name で指定したクラス、モジュールを追加します。

...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param superclass 追加するクラスの親クラスを RDoc::NormalClass...
...オ
ブジェクトで指定します。

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

RDoc::TopLevel#file_absolute_name -> String (9004.0)

自身が管理するファイルに関する絶対パスを文字列で返します。

自身が管理するファイルに関する絶対パスを文字列で返します。

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

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

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

RDoc::TopLevel#find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant (9004.0)

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

RDoc::TopLevel#find_module_named(name) -> RDoc::NormalModule (9004.0)

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。

...
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。

@param name モジュール名を文字列で指定します。...

絞り込み条件を変える

RDoc::TopLevel#full_name -> String (9004.0)

自身が管理するファイルの名前を返します。

自身が管理するファイルの名前を返します。

RDoc::TopLevel.all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule] (9004.0)

RDoc が収集したクラス、モジュールを配列で返します。

...
RDoc が収集したクラス、モジュールを配列で返します。...

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (9004.0)

RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。

...
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。

@param name クラス名を文字列で指定します。...

RDoc::TopLevel.reset -> () (9004.0)

RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ ル)をクリアします。

...
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ
ル)をクリアします。...

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Record the file that we happen to find it in

Record the file that we happen to find it in

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

使用されていません。

使用されていません。

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

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

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

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

RDoc::Options#hyperlink_all=(val) (304.0)

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

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

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

RDoc::Options#line_numbers=(val) (304.0)

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

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

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

RDoc::Options#main_page=(val) (304.0)

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

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

@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。

絞り込み条件を変える

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

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

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

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

RDoc::Options#op_dir=(val) (304.0)

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

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

@param val 設定するディレクトリを文字列で指定します。

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

コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。

コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。

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

RDoc::Options#page_dir=(val) (304.0)

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

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

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

RDoc::Options#parse(argv) -> () (304.0)

コマンドライン引数を解析します。

コマンドライン引数を解析します。

@param argv コマンドライン引数を文字列の配列で指定します。


また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

絞り込み条件を変える

RDoc::Options#pipe=(val) (304.0)

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

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

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

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

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

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

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

RDoc::Options#show_all=(val) (304.0)

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

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

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

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

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

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

@param vals パスを文字列の配列で指定します。

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

コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。

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

絞り込み条件を変える

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (304.0)

file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

... RDoc::Parser::Simple のインスタンスを返します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Op...
...tions オブジェクトを指定します。

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

RDoc::Parser::C#progress=(val) (304.0)

進捗を出力する IO を指定します。

進捗を出力する IO を指定します。

@param val 進捗を出力する IO を指定します。指定しなかった場合は
$stderr が使われます。

RDoc::Parser::C#scan -> RDoc::TopLevel (304.0)

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。

...C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

RDoc::Parser::C.new(top_level, file_name, body, options, stats) -> RDoc::Parser::C (304.0)

自身を初期化します。

...op_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats...

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (304.0)

ChangeLog ファイルを解析します。

...ChangeLog ファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

絞り込み条件を変える

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (304.0)

Markdown 形式で記述されたファイルを解析します。

...Markdown 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

RDoc::Parser::RD#scan -> RDoc::TopLevel (304.0)

RD 形式で記述されたファイルを解析します。

...RD 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (304.0)

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

...Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

RDoc::Parser::Ruby.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby (304.0)

自身を初期化します。

...op_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats...

RDoc::Parser::Simple#scan -> RDoc::TopLevel (304.0)

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。

...自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。

@return RDoc::TopLevel オブジェクトを返します。...

絞り込み条件を変える

RDoc::Parser::Simple.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Simple (304.0)

自身を初期化します。

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

@param file_name ファイル名を文字列で指定します。

@param body 内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジ...

RDoc::RDoc#document(argv) -> nil (304.0)

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

...ドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

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

指定できるオプションについては、lib:rdoc#usage を参照し...

RDoc::Stats#num_classes=(val) (304.0)

解析したクラスの数を指定します。

解析したクラスの数を指定します。

@param val 数値を指定します。

RDoc::Stats#num_files=(val) (304.0)

解析したファイルの数を指定します。

解析したファイルの数を指定します。

@param val 数値を指定します。

RDoc::Stats#num_methods=(val) (304.0)

解析したメソッドの数を指定します。

解析したメソッドの数を指定します。

@param val 数値を指定します。

絞り込み条件を変える

RDoc::Stats#num_modules=(val) (304.0)

解析したモジュールの数を指定します。

解析したモジュールの数を指定します。

@param val 数値を指定します。

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

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

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

Powered by Ruby 3.1.2.

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