るりまサーチ (Ruby 3.0)

最速Rubyリファレンスマニュアル検索！
232件ヒット [1-100件を表示] （0.106秒）
トップページ > クエリ:t[x] > クエリ:rdoc[x] > 種類:インスタンスメソッド[x] > バージョン:3.0[x]

別のキーワード

  1. openssl t61string
  2. asn1 t61string
  3. matrix t
  4. t61string new
  5. fiddle type_size_t

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

  1. Gem::Specification#rdoc_options=(options)
  2. Gem::Specification#rdoc_options -> [String]
  3. Rake::RDocTask#template=(template)
  4. Gem::Specification#extra_rdoc_files -> [String]
  5. RDoc::Context#attributes -> [RDoc::Attr]
<< 1 2 3 > >>

Gem::Specification#rdoc_options=(options) (45973.0)

  • インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。

Gem::Specification#rdoc_options -> [String] (45655.0)

  • インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

Rake::RDocTask#template=(template) (37204.0)

  • インスタンスメソッド

使用するテンプレートをセットします。

使用するテンプレートをセットします。

@param template 使用するテンプレートを指定します。

Gem::Specification#extra_rdoc_files -> [String] (36955.0)

  • インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

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

  • インスタンスメソッド

追加された RDoc::Attr の配列を返します。

追加された RDoc::Attr の配列を返します。

絞り込み条件を変える

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

  • インスタンスメソッド

追加された RDoc::Attr に対してブロックを評価します。

追加された RDoc::Attr に対してブロックを評価します。

Gem::DocManager#setup_rdoc (36673.0)

  • インスタンスメソッド

RDoc を実行するための準備を行います。

RDoc を実行するための準備を行います。

@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。

Gem::Specification#extra_rdoc_files=(paths) (36673.0)

  • インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。

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

  • インスタンスメソッド

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

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

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

Gem::DocManager#generate_rdoc (36655.0)

  • インスタンスメソッド

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

絞り込み条件を変える

Gem::DocManager#install_rdoc (36655.0)

  • インスタンスメソッド

RDoc を生成してインストールします。

RDoc を生成してインストールします。

Gem::DocManager#rdoc_installed? -> bool (36655.0)

  • インスタンスメソッド

RDoc がインストール済みの場合は、真を返します。 そうでない場合は偽を返します。

RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。

Rake::RDocTask#rdoc_files -> Rake::FileList (36655.0)

  • インスタンスメソッド

RDoc の生成に使用するファイルリストを返します。 デフォルトは空です。

RDoc の生成に使用するファイルリストを返します。
デフォルトは空です。

Rake::RDocTask#rdoc_files=(filelist) (36655.0)

  • インスタンスメソッド

RDoc の生成に使用するファイルリストをセットします。

RDoc の生成に使用するファイルリストをセットします。

@param filelist ファイルリストを指定します。

Rake::RDocTask#template -> String (36652.0)

  • インスタンスメソッド

使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。

使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。

絞り込み条件を変える

RDoc::Options#rdoc_include -> [String] (36607.0)

  • インスタンスメソッド

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

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

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

Rake::RDocTask#rdoc_dir -> String (36607.0)

  • インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。

作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

Handle sections

Handle sections

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

  • インスタンスメソッド

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

オプションの解析前は nil を返します。

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

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

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。

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

  • インスタンスメソッド

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。

絞り込み条件を変える

Rake::RDocTask#rdoc_dir=(dir) (36307.0)

  • インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名をセットします。

作成した HTML ファイルを保存するディレクトリ名をセットします。

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

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

  • インスタンスメソッド

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

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

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

  • インスタンスメソッド

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。

コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。

@param string 設定するタイトルを文字列で指定します。

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

  • インスタンスメソッド

RDoc::Generator::Darkfish オブジェクトを初期化します。

RDoc::Generator::Darkfish オブジェクトを初期化します。

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

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

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

  • インスタンスメソッド

RDoc::Generator::RI オブジェクトを初期化します。

RDoc::Generator::RI オブジェクトを初期化します。

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

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

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

  • インスタンスメソッド

追加された RDoc::Constant の配列を返します。

追加された RDoc::Constant の配列を返します。

絞り込み条件を変える

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

  • インスタンスメソッド

追加された RDoc::Constant に対してブロックを評価します。

追加された RDoc::Constant に対してブロックを評価します。

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

  • インスタンスメソッド

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。

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

  • インスタンスメソッド

追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。

追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。

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

  • インスタンスメソッド

追加された RDoc::Context::Section の配列を返します。

追加された RDoc::Context::Section の配列を返します。

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

  • インスタンスメソッド

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

所属している section を返します。

所属している section を返します。

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

  • インスタンスメソッド

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

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。

Rake::RDocTask#options=(options) (27670.0)

  • インスタンスメソッド

rdoc コマンドに渡すオプションのリストをセットします。

rdoc コマンドに渡すオプションのリストをセットします。

@param options rdoc コマンドに渡されるオプションを指定します。

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (27658.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::Context#unmatched_alias_lists -> {String => RDoc::Alias} (27655.0)

  • インスタンスメソッド

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

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

Rake::RDocTask#title=(title) (27652.0)

  • インスタンスメソッド

RDoc のタイトルをセットします。

RDoc のタイトルをセットします。

@param title タイトルを指定します。

絞り込み条件を変える

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

  • インスタンスメソッド

現在の section を返します。

現在の section を返します。

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

@param visibility 可視性を :public, :protected, :private の内のいずれか
で指定します。

@param singleton 特異メソッドの可視性を変更する場合は...

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

  • インスタンスメソッド

array に thing を追加します。

array に thing を追加します。

@param array 配列を指定します。

@param 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_requ...

Gem::Specification#has_rdoc? -> bool (27421.0)

  • インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

@see Gem::Specification#has_rdoc

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

  • インスタンスメソッド

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

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

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

@see RDoc::CodeObject#end_doc

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

@see RDoc::CodeObject#start_doc

Gem::Specification#has_rdoc -> bool (27403.0)

  • インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

RDoc::Text#normalize_comment(text) -> String (27376.0)

  • インスタンスメソッド

引数から行頭のスペースや改行文字などを削除します。

引数から行頭のスペースや改行文字などを削除します。

詳しくは [SEE ALSO] の各メソッドを参照してください。

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

@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

絞り込み条件を変える

Rake::RDocTask#options -> Array (27370.0)

  • インスタンスメソッド

rdoc コマンドに渡すオプションのリストを返します。

rdoc コマンドに渡すオプションのリストを返します。

指定できるオプションは -o, --main, --title, -T 以外です。

Gem::Specification#has_rdoc=(flag) (27355.0)

  • インスタンスメソッド

RDoc を生成するかどうかをセットします。デフォルトは偽です。

RDoc を生成するかどうかをセットします。デフォルトは偽です。

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

絞り込み条件を変える

Rake::RDocTask#external -> bool (27352.0)

  • インスタンスメソッド

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。 デフォルトは偽です。

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。
デフォルトは偽です。

Rake::RDocTask#external=(flag) (27352.0)

  • インスタンスメソッド

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

@param flag 真または偽を指定します。

Rake::RDocTask#option_list -> Array (27352.0)

  • インスタンスメソッド

rdoc コマンドに渡すオプションのリストを返します。

rdoc コマンドに渡すオプションのリストを返します。

Rake::RDocTask#option_string -> String (27352.0)

  • インスタンスメソッド

rdoc コマンドに渡すオプションを文字列として返します。

rdoc コマンドに渡すオプションを文字列として返します。

Rake::RDocTask#title -> String (27352.0)

  • インスタンスメソッド

RDoc のタイトルを返します。 デフォルト値はありません。

RDoc のタイトルを返します。
デフォルト値はありません。

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

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

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

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

  • インスタンスメソッド

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

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

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

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

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

RDoc::Markup#add_html(tag, name) -> () (27340.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::Parser#parse_files_matching(regexp) -> () (27340.0)

  • インスタンスメソッド

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

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

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

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

例:

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

Gem::InstallUpdateOptions#install_update_defaults_str -> String (27322.0)

  • インスタンスメソッド

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

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

  • インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

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

  • インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

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

@see SM::SimpleMarkup#convert

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

  • インスタンスメソッド

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

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

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

@see SM::SimpleMarkup#convert

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

  • インスタンスメソッド

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

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

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

@see RDoc::Options#verbosity

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

  • インスタンスメソッド

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

Change the default visibility for new methods

Change the default visibility for new methods

絞り込み条件を変える

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

  • インスタンスメソッド

Record the file that we happen to find it in

Record the file that we happen to find it in

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える

<< 1 2 3 > >>

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

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

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

Powered by Ruby 3.1.2.

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