ライブラリ
- ビルトイン (2)
- rake (1)
-
rake
/ rdoctask (20) -
rdoc
/ code _ object (18) -
rdoc
/ context (49) -
rdoc
/ generator / darkfish (2) -
rdoc
/ generator / json _ index (1) -
rdoc
/ generator / ri (2) -
rdoc
/ markdown (15) -
rdoc
/ markup (7) -
rdoc
/ markup / formatter (2) -
rdoc
/ parser (1) -
rdoc
/ parser / c (2) -
rdoc
/ parser / changelog (1) -
rdoc
/ parser / markdown (1) -
rdoc
/ parser / rd (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / simple (2) -
rdoc
/ rdoc (1) -
rdoc
/ stats (9) -
rdoc
/ text (8) -
rdoc
/ top _ level (10) -
rubygems
/ doc _ manager (6) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (6) -
Gem
:: Specification (7) - Module (2)
-
RDoc
:: CodeObject (18) -
RDoc
:: Context (42) -
RDoc
:: Context :: Section (7) -
RDoc
:: Generator :: Darkfish (2) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Generator :: RI (2) -
RDoc
:: Markdown (15) -
RDoc
:: Markup (7) -
RDoc
:: Markup :: Formatter (2) -
RDoc
:: Options (70) -
RDoc
:: Parser (1) -
RDoc
:: Parser :: C (2) -
RDoc
:: Parser :: ChangeLog (1) -
RDoc
:: Parser :: Markdown (1) -
RDoc
:: Parser :: RD (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (2) -
RDoc
:: RDoc (1) -
RDoc
:: Stats (9) -
RDoc
:: TopLevel (10) -
Rake
:: RDocTask (20)
モジュール
-
Gem
:: InstallUpdateOptions (1) - Kernel (1)
-
RDoc
:: Text (8)
キーワード
- <=> (1)
- == (1)
-
add
_ alias (1) -
add
_ attribute (1) -
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ constant (1) -
add
_ html (1) -
add
_ include (1) -
add
_ method (1) -
add
_ module (1) -
add
_ require (1) -
add
_ special (1) -
add
_ tag (1) -
add
_ to (1) -
add
_ word _ pair (1) - aliases (1)
-
all
_ one _ file (1) -
attribute
_ manager (1) - attributes (1)
-
break
_ on _ newline (1) -
break
_ on _ newline= (1) - charset (1)
- classes (1)
- comment (2)
- comment= (1)
- constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (2)
- css= (1)
-
current
_ section (1) - define (1)
-
defined
_ in? (1) -
definition
_ lists (1) -
definition
_ lists= (1) - diagram (1)
- document (1)
-
document
_ children (1) -
document
_ children= (1) -
document
_ self (1) -
document
_ self= (1) - documented? (1)
-
dry
_ run (1) -
dry
_ run= (1) -
each
_ attribute (1) -
each
_ classmodule (1) -
each
_ constant (1) -
each
_ method (1) - encoding (1)
- encoding= (1)
- exclude (1)
- exclude= (1)
- extension (1)
- extension? (1)
- external (1)
- external= (1)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) -
extra
_ rdoc _ files (1) -
extra
_ rdoc _ files= (1) -
file
_ absolute _ name (1) -
file
_ absolute _ name= (1) -
file
_ relative _ name (1) -
file
_ relative _ name= (1) -
file
_ stat (1) -
file
_ stat= (1) - fileboxes (1)
- files (1)
-
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (2) -
find
_ module _ named (2) -
find
_ symbol (1) -
finish
_ page _ dir (1) -
flush
_ left (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
-
full
_ name (1) - generate (3)
-
generate
_ rdoc (1) - generator (1)
- generator= (1)
-
get
_ line _ types (1) - github (1)
- github= (1)
-
has
_ rdoc (1) -
has
_ rdoc= (1) -
has
_ rdoc? (1) - html (1)
- html= (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
image
_ format (1) -
in
_ files (1) -
include
_ line _ numbers (1) - includes (1)
- initialize (2)
-
initialize
_ classes _ and _ modules (1) -
initialize
_ methods _ etc (1) -
inline
_ source (1) - inspect (1)
-
install
_ rdoc (1) -
install
_ update _ defaults _ str (1) -
line
_ numbers (1) -
line
_ numbers= (1) - main (1)
- main= (1)
-
main
_ page (1) -
main
_ page= (1) - markup (2)
- markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- multitask (1)
- name (2)
- name= (1)
-
normalize
_ comment (1) - notes (1)
- notes= (1)
-
num
_ classes (1) -
num
_ classes= (1) -
num
_ files (1) -
num
_ files= (1) -
num
_ methods (1) -
num
_ methods= (1) -
num
_ modules (1) -
num
_ modules= (1) -
ongoing
_ visibility= (1) -
op
_ dir (1) -
op
_ dir= (1) -
op
_ name (1) -
option
_ list (1) -
option
_ parser (1) -
option
_ parser= (1) -
option
_ string (1) -
page
_ dir (1) -
page
_ dir= (1) - parent (2)
- parent= (1)
-
parent
_ file _ name (1) -
parent
_ name (1) - parse (3)
-
parse
_ files _ matching (1) - pipe (1)
- pipe= (1)
- print (1)
- progress= (1)
- promiscuous (1)
- quiet (1)
- quote (1)
-
rdoc
_ dir (1) -
rdoc
_ dir= (1) -
rdoc
_ files (1) -
rdoc
_ files= (1) -
rdoc
_ include (1) -
rdoc
_ installed? (1) -
record
_ location (1) - refine (1)
-
remove
_ classes _ and _ modules (1) -
remove
_ methods _ etc (1) -
remove
_ private _ comments (1) - requires (1)
- root (1)
- root= (1)
-
run
_ rdoc (1) -
sanitize
_ path (1) - scan (6)
- section (1)
- section= (1)
- sections (1)
- sequence (1)
-
set
_ comment (1) -
set
_ current _ section (1) -
set
_ visibility _ for (1) -
setup
_ rdoc (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
start
_ doc (1) -
static
_ path (1) -
static
_ path= (1) -
stop
_ doc (1) -
strip
_ hashes (1) -
strip
_ newlines (1) -
strip
_ stars (1) -
tab
_ width (1) - template (2)
- template= (1)
-
template
_ dir (1) -
template
_ dir= (1) - title (3)
- title= (2)
- toplevel (1)
-
uninstall
_ doc (1) -
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) - using (1)
- verbosity (1)
- verbosity= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
検索結果
先頭5件
-
RDoc
:: Options # verbosity -> 0 | 1 | 2 (9004.0) -
プログラムの解析時に表示する情報の詳細さを数値で返します。
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
: 0(--quiet オプションを指定した場合)
情報を表示しません。
: 1
通常の表示を行います。
: 2(--verbose オプションを指定した場合)
詳細な情報を表示します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (9004.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # visibility=(val) (9004.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Options # warn(message) -> nil (9004.0) -
--verbose オプションを指定していた場合に message を 標準エラー出力 $stderr に出力します。
--verbose オプションを指定していた場合に message を 標準エラー出力
$stderr に出力します。 -
RDoc
:: Options # webcvs -> String | nil (9004.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
RDoc
:: Parser :: C # progress=(val) (9004.0) -
進捗を出力する IO を指定します。
進捗を出力する IO を指定します。
@param val 進捗を出力する IO を指定します。指定しなかった場合は
$stderr が使われます。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (9004.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Stats # num _ classes -> Integer (9004.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ classes=(val) (9004.0) -
解析したクラスの数を指定します。
解析したクラスの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ files -> Integer (9004.0) -
解析したファイルの数を返します。
解析したファイルの数を返します。 -
RDoc
:: Stats # num _ files=(val) (9004.0) -
解析したファイルの数を指定します。
解析したファイルの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ methods -> Integer (9004.0) -
解析したメソッドの数を返します。
解析したメソッドの数を返します。 -
RDoc
:: Stats # num _ methods=(val) (9004.0) -
解析したメソッドの数を指定します。
解析したメソッドの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ modules -> Integer (9004.0) -
解析したモジュールの数を返します。
解析したモジュールの数を返します。 -
RDoc
:: Stats # num _ modules=(val) (9004.0) -
解析したモジュールの数を指定します。
解析したモジュールの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # print -> () (9004.0) -
自身の持つ情報を標準出力に表示します。
自身の持つ情報を標準出力に表示します。 -
RDoc
:: Text # expand _ tabs(text) -> String (9004.0) -
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。
@param text 文字列を指定します。 -
RDoc
:: Text # flush _ left(text) -> String (9004.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # markup(text) -> String (9004.0) -
引数を整形します。
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ hashes(text) -> String (9004.0) -
引数から各行の行頭の # を削除します。
引数から各行の行頭の # を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ newlines(text) -> String (9004.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ stars(text) -> String (9004.0) -
引数から /* 〜 */ 形式のコメントを削除します。
引数から /* 〜 */ 形式のコメントを削除します。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # file _ absolute _ name -> String (9004.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ absolute _ name=(val) (9004.0) -
自身が管理するファイルに関する絶対パスを文字列で設定します。
自身が管理するファイルに関する絶対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (9004.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (9004.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ stat -> File :: Stat (9004.0) -
自身が管理するファイルに関する File::Stat オブジェクトを返します。
自身が管理するファイルに関する File::Stat オブジェクトを返します。 -
RDoc
:: TopLevel # file _ stat=(val) (9004.0) -
自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。
自身が管理するファイルに関する File::Stat オブジェクトを設定しま
す。
@param val File::Stat オブジェクトを指定します。 -
RDoc
:: TopLevel # full _ name -> String (9004.0) -
自身が管理するファイルの名前を返します。
自身が管理するファイルの名前を返します。 -
Rake
:: RDocTask # define -> self (9004.0) -
タスクを定義します。
タスクを定義します。 -
Rake
:: RDocTask # main -> String (9004.0) -
メインとして使用されるファイル名を返します。
メインとして使用されるファイル名を返します。 -
Rake
:: RDocTask # main=(filename) (9004.0) -
メインとして使用されるファイル名をセットします。
メインとして使用されるファイル名をセットします。 -
Rake
:: RDocTask # name=(name) (9004.0) -
タスクの名前をセットします。
タスクの名前をセットします。
@param name タスクの名前を指定します。 -
Rake
:: RDocTask # quote(str) -> String (9004.0) -
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
@param str クオートする文字列を指定します。 -
Rake
:: RDocTask # template=(template) (9004.0) -
使用するテンプレートをセットします。
使用するテンプレートをセットします。
@param template 使用するテンプレートを指定します。 -
Gem
:: DocManager # uninstall _ doc (52.0) -
RDoc と RI 用のデータを削除します。
RDoc と RI 用のデータを削除します。 -
Gem
:: InstallUpdateOptions # install _ update _ defaults _ str -> String (22.0) -
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers -
Kernel
# multitask(args) { . . . } -> Rake :: MultiTask (22.0) -
事前タスクを並列実行するタスクを定義します。
事前タスクを並列実行するタスクを定義します。
与えられた事前タスクを実行する順序は不定です。
例:
multitask :deploy => [:deploy_gem, :deploy_rdoc] -
Module
# refine(klass) { . . . } -> Module (22.0) -
引数 klass で指定したクラスまたはモジュールだけに対して、ブロックで指定した機能を提供で きるモジュールを定義します。定義した機能は Module#refine を使用せずに直 接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。 そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。
引数 klass で指定したクラスまたはモジュールだけに対して、ブロックで指定した機能を提供で
きるモジュールを定義します。定義した機能は Module#refine を使用せずに直
接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。
そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。
refinements 機能の詳細については以下を参照してください。
* https://magazine.rubyist.net/articles/0041/0041-200Special-refinement.html
* https://docs... -
Module
# using(module) -> self (22.0) -
引数で指定したモジュールで定義された拡張を現在のクラス、モジュールで有 効にします。
引数で指定したモジュールで定義された拡張を現在のクラス、モジュールで有
効にします。
有効にした拡張の有効範囲については以下を参照してください。
* https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html#label-Scope
@param module 有効にするモジュールを指定します。
@see Module#refine, main.using