:![[x]](/images/drop-condition-icon.png "条件を削除"){kind=icon}
:
:3.0ライブラリ
-
rake
/ rdoctask (7) -
rdoc
/ code _ object (3) -
rdoc
/ context (6) -
rdoc
/ markup (4) -
rdoc
/ parser / simple (1) -
rdoc
/ text (7) -
rdoc
/ top _ level (3) -
rubygems
/ specification (2)
クラス
-
Gem
:: Specification (2) -
RDoc
:: CodeObject (3) -
RDoc
:: Context (2) -
RDoc
:: Context :: Section (4) -
RDoc
:: Markup (4) -
RDoc
:: Options (16) -
RDoc
:: Parser :: Simple (1) -
RDoc
:: TopLevel (3) -
Rake
:: RDocTask (7)
モジュール
-
Gem
:: InstallUpdateOptions (1) -
RDoc
:: Text (7)
キーワード
-
add
_ html (1) -
add
_ special (1) -
add
_ word _ pair (1) - charset (1)
- comment (2)
- content (1)
- css (1)
-
extra
_ accessor _ flags (1) -
extra
_ rdoc _ files (1) -
file
_ absolute _ name (1) -
file
_ relative _ name (1) - files (1)
-
flush
_ left (1) -
full
_ name (1) -
image
_ format (1) - inspect (1)
-
install
_ update _ defaults _ str (1) - main (1)
-
main
_ page (1) - markup (2)
- name (2)
-
normalize
_ comment (1) -
op
_ dir (1) -
op
_ name (1) -
option
_ string (1) -
parent
_ file _ name (1) -
parent
_ name (1) - quote (1)
-
rdoc
_ dir (1) -
rdoc
_ include (1) -
remove
_ private _ comments (1) - sequence (1)
-
static
_ path (1) -
strip
_ hashes (1) -
strip
_ newlines (1) -
strip
_ stars (1) - template (2)
-
template
_ dir (1) - title (3)
- title= (1)
-
unmatched
_ alias _ lists (1) - webcvs (1)
検索結果
先頭5件
-
Rake
:: RDocTask # option _ string -> String (27658.0) -
rdoc コマンドに渡すオプションを文字列として返します。
rdoc コマンドに渡すオプションを文字列として返します。 -
RDoc
:: Options # rdoc _ include -> [String] (27610.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
Rake
:: RDocTask # rdoc _ dir -> String (27610.0) -
作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。
作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。 -
Gem
:: Specification # extra _ rdoc _ files -> [String] (18658.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。 -
Gem
:: Specification # rdoc _ options -> [String] (18658.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。 -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (9658.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (9610.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Text # normalize _ comment(text) -> String (9379.0) -
引数から行頭のスペースや改行文字などを削除します。
引数から行頭のスペースや改行文字などを削除します。
詳しくは [SEE ALSO] の各メソッドを参照してください。
@param text 文字列を指定します。
@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines -
RDoc
:: Options # title=(string) (9373.0) -
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。
@param string 設定するタイトルを文字列で指定します。 -
Rake
:: RDocTask # name -> String (9355.0) -
タスクの名前を返します。デフォルトは rdoc です。
タスクの名前を返します。デフォルトは rdoc です。 -
Rake
:: RDocTask # template -> String (9355.0) -
使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。
使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。 -
Rake
:: RDocTask # title -> String (9355.0) -
RDoc のタイトルを返します。 デフォルト値はありません。
RDoc のタイトルを返します。
デフォルト値はありません。 -
RDoc
:: CodeObject # parent _ file _ name -> String (9325.0) -
self.parent のファイル名を返します。
self.parent のファイル名を返します。
@see RDoc::CodeObject#parent -
RDoc
:: CodeObject # parent _ name -> String (9325.0) -
self.parent の名前を返します。
self.parent の名前を返します。
@see RDoc::CodeObject#parent -
RDoc
:: Markup # content -> String (9325.0) -
変換する文字列を返します。
変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。
@see SM::SimpleMarkup#convert -
RDoc
:: Options # markup -> String (9325.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。 -
RDoc
:: CodeObject # comment -> String (9307.0) -
自身のコメントを返します。
自身のコメントを返します。 -
RDoc
:: Context # name -> String (9307.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context :: Section # comment -> String | nil (9307.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (9307.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # sequence -> String (9307.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Context :: Section # title -> String | nil (9307.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Options # charset -> String (9307.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # css -> String (9307.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # files -> [String] (9307.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # image _ format -> String (9307.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # main _ page -> String | nil (9307.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # op _ dir -> String (9307.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ name -> String (9307.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: Options # static _ path -> [String] (9307.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # template -> String (9307.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
RDoc
:: Options # template _ dir -> String | nil (9307.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # title -> String | nil (9307.0) -
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。 -
RDoc
:: Options # webcvs -> String | nil (9307.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (9307.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Text # expand _ tabs(text) -> String (9307.0) -
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。
@param text 文字列を指定します。 -
RDoc
:: Text # flush _ left(text) -> String (9307.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # markup(text) -> String (9307.0) -
引数を整形します。
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ hashes(text) -> String (9307.0) -
引数から各行の行頭の # を削除します。
引数から各行の行頭の # を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ newlines(text) -> String (9307.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ stars(text) -> String (9307.0) -
引数から /* 〜 */ 形式のコメントを削除します。
引数から /* 〜 */ 形式のコメントを削除します。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # file _ absolute _ name -> String (9307.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (9307.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # full _ name -> String (9307.0) -
自身が管理するファイルの名前を返します。
自身が管理するファイルの名前を返します。 -
Rake
:: RDocTask # main -> String (9307.0) -
メインとして使用されるファイル名を返します。
メインとして使用されるファイル名を返します。 -
Rake
:: RDocTask # quote(str) -> String (9307.0) -
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
@param str クオートする文字列を指定します。 -
RDoc
:: Markup # add _ html(tag , name) -> () (9058.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
:: Markup # add _ special(pattern , name) -> () (9058.0) -
pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。
pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。
例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。
@param pattern 正規表現を指定します。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require '... -
RDoc
:: Markup # add _ word _ pair(start , stop , name) -> () (9058.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。
@param start 開始となる文字列を指定します。
@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/... -
Gem
:: InstallUpdateOptions # install _ update _ defaults _ str -> String (325.0) -
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers