ライブラリ
-
rake
/ rdoctask (3) -
rdoc
/ code _ object (2) -
rdoc
/ context (7) -
rdoc
/ markdown (2) -
rdoc
/ markup (3) -
rdoc
/ markup / formatter (1) -
rdoc
/ top _ level (8)
クラス
-
RDoc
:: CodeObject (2) -
RDoc
:: Context (7) -
RDoc
:: Markdown (2) -
RDoc
:: Markup (3) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Options (3) -
RDoc
:: TopLevel (8) -
Rake
:: RDocTask (3)
キーワード
- <=> (1)
-
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ html (1) -
add
_ module (1) -
add
_ special (1) -
add
_ tag (1) -
add
_ word _ pair (1) - extension (1)
- extension? (1)
-
file
_ absolute _ name (1) -
file
_ absolute _ name= (1) -
file
_ relative _ name (1) -
file
_ relative _ name= (1) -
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (1) -
find
_ module _ named (2) -
full
_ name (1) - main= (1)
- name= (1)
-
op
_ name (1) -
page
_ dir (1) -
parent
_ file _ name (1) -
parent
_ name (1) - root (1)
検索結果
先頭5件
-
Rake
:: RDocTask # name -> String (72655.0) -
タスクの名前を返します。デフォルトは rdoc です。
タスクの名前を返します。デフォルトは rdoc です。 -
RDoc
:: Context # name -> String (72607.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: CodeObject # parent _ file _ name -> String (45625.0) -
self.parent のファイル名を返します。
self.parent のファイル名を返します。
@see RDoc::CodeObject#parent -
RDoc
:: CodeObject # parent _ name -> String (45625.0) -
self.parent の名前を返します。
self.parent の名前を返します。
@see RDoc::CodeObject#parent -
RDoc
:: TopLevel # file _ absolute _ name -> String (45607.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ absolute _ name=(val) (45607.0) -
自身が管理するファイルに関する絶対パスを文字列で設定します。
自身が管理するファイルに関する絶対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (45607.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (45607.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # find _ module _ named(name) -> RDoc :: NormalModule (37024.0) -
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。
@param name モジュール名を文字列で指定します。 -
RDoc
:: Context # find _ module _ named(name) -> RDoc :: NormalModule | nil (36976.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。 -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (36910.0) -
find a module at a higher scope
find a module at a higher scope -
Rake
:: RDocTask # name=(name) (36628.0) -
タスクの名前をセットします。
タスクの名前をセットします。
@param name タスクの名前を指定します。 -
RDoc
:: Options # op _ name -> String (36607.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: TopLevel # full _ name -> String (36607.0) -
自身が管理するファイルの名前を返します。
自身が管理するファイルの名前を返します。 -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (28027.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
:: Markdown # extension(name , enable) -> () (27673.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (27673.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markup # add _ html(tag , name) -> () (27661.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
:: Options # root -> Pathname (27604.0) -
コマンドライン引数の --root オプションで指定したディレクトリを返します。
コマンドライン引数の --root オプションで指定したディレクトリを返します。
指定されていない場合はカレントディレクトリを返します。 -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (20776.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19672.0) -
collection に name で指定したクラス、モジュールを追加します。
collection に name で指定したクラス、モジュールを追加します。
@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param su... -
RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19672.0) -
collection に name で指定したクラス、モジュールを追加します。
collection に name で指定したクラス、モジュールを追加します。
@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param su... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (19606.0) -
引数で指定したモジュールを追加します。
引数で指定したモジュールを追加します。
ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (19303.0) -
引数で指定したクラスを追加します。
引数で指定したクラスを追加します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。 -
RDoc
:: Options # page _ dir -> Pathname | nil (18604.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (18352.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
Rake
:: RDocTask # main=(filename) (18304.0) -
メインとして使用されるファイル名をセットします。
メインとして使用されるファイル名をセットします。 -
RDoc
:: Markup # add _ special(pattern , name) -> () (9679.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) -> () (9661.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。
@param start 開始となる文字列を指定します。
@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/...