ライブラリ
- ビルトイン (11)
-
cgi
/ html (2) - date (1)
- forwardable (12)
- getoptlong (2)
- matrix (1)
-
net
/ http (2) -
net
/ imap (2) -
net
/ pop (3) -
net
/ smtp (2) - openssl (10)
- optparse (8)
- pathname (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) - rss (78)
-
rubygems
/ dependency _ list (1) -
rubygems
/ doc _ manager (5) -
rubygems
/ specification (7) -
rubygems
/ validator (1) - socket (1)
- uri (2)
-
webrick
/ httpauth / authenticator (1) -
webrick
/ httpauth / basicauth (1) -
webrick
/ httpauth / userdb (5)
クラス
- BasicSocket (1)
- Date (1)
-
Encoding
:: Converter (1) - Exception (1)
-
File
:: Stat (4) -
Gem
:: DependencyList (1) -
Gem
:: DocManager (5) -
Gem
:: Specification (7) -
Gem
:: Validator (1) - GetoptLong (2)
- Integer (1)
- Matrix (1)
- Module (1)
-
Net
:: IMAP (2) -
Net
:: POP3 (3) -
Net
:: SMTP (2) -
OpenSSL
:: PKey :: EC :: Group (2) -
OpenSSL
:: SSL :: SSLServer (1) - OptionParser (6)
- Pathname (1)
- Proc (1)
-
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) -
RSS
:: RDF (17) -
RSS
:: RDF :: Channel (16) -
RSS
:: RDF :: Channel :: Image (2) -
RSS
:: RDF :: Channel :: ImageFavicon (8) -
RSS
:: RDF :: Channel :: Items (1) -
RSS
:: RDF :: Channel :: Textinput (2) -
RSS
:: RDF :: Image (10) -
RSS
:: RDF :: Item (10) -
RSS
:: RDF :: Textinput (12) -
Rake
:: RDocTask (20) - String (1)
- Time (1)
-
URI
:: Generic (2) -
WEBrick
:: HTTPAuth :: BasicAuth (1)
モジュール
キーワード
- <=> (1)
- == (1)
- about (5)
- about= (5)
-
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) - addr (1)
- aliases (1)
- alien (1)
-
all
_ one _ file (1) -
attribute
_ manager (1) - attributes (1)
-
auth
_ only (1) -
auth
_ type (1) -
auth
_ type= (1) - authenticate (1)
-
basic
_ auth (1) -
break
_ on _ newline (1) -
break
_ on _ newline= (1) - channel (1)
- channel= (1)
- chardev? (2)
- charset (1)
- classes (1)
- closed? (1)
- comment (2)
- comment= (1)
- constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (2)
- css= (1)
-
current
_ section (1) - date (5)
- date= (5)
-
def
_ delegator (2) -
def
_ delegators (2) -
def
_ instance _ delegator (1) -
def
_ instance _ delegators (1) -
def
_ single _ delegator (1) -
def
_ single _ delegators (1) - define (1)
-
defined
_ in? (1) -
definition
_ lists (1) -
definition
_ lists= (1) - delegate (2)
-
dependency
_ order (1) - description (3)
- description= (3)
- diagram (1)
-
do
_ not _ reverse _ lookup= (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 (2)
- encoding= (2)
- 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) - fcntl (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) -
get
_ passwd (1) - getsockopt (1)
- github (1)
- github= (1)
-
hadamard
_ product (1) -
has
_ rdoc (1) -
has
_ rdoc= (1) -
has
_ rdoc? (1) - html (1)
- html= (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) - image (2)
- image= (2)
-
image
_ format (1) -
image
_ size (1) -
image
_ size= (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) -
instance
_ delegate (1) - item (1)
- item= (1)
- items (2)
- items= (1)
-
line
_ numbers (1) -
line
_ numbers= (1) - link (4)
- link= (4)
- login (1)
- main (1)
- main= (1)
-
main
_ page (1) -
main
_ page= (1) -
make
_ passwd (1) - markup (2)
- markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- name (3)
- name= (2)
-
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) - ord (2)
- order (5)
- order! (4)
- ordering (1)
- ordering= (1)
-
page
_ dir (1) -
page
_ dir= (1) - parent (2)
- parent= (1)
-
parent
_ file _ name (1) -
parent
_ name (1) - parse (3)
-
parse
_ files _ matching (1) - password (1)
- password= (1)
-
password
_ field (2) - peeraddr (1)
- pipe (1)
- pipe= (1)
-
primitive
_ errinfo (1) - print (1)
- progress= (1)
- promiscuous (1)
-
proxy
_ basic _ auth (1) - quiet (1)
- quote (1)
- rdev (1)
-
rdev
_ major (1) -
rdev
_ minor (1) -
rdoc
_ dir (1) -
rdoc
_ dir= (1) -
rdoc
_ files (1) -
rdoc
_ files= (1) -
rdoc
_ include (1) -
rdoc
_ installed? (1) -
record
_ location (1) -
remove
_ classes _ and _ modules (1) -
remove
_ methods _ etc (1) -
remove
_ private _ comments (1) - requires (1)
- resource (2)
- resource= (2)
- resources (1)
- root (1)
- root= (1)
-
rss
_ version (1) -
rss
_ version= (1) -
ruby2
_ keywords (2) -
run
_ rdoc (1) -
sanitize
_ path (1) - saturday? (2)
- scan (6)
- section (1)
- section= (1)
- sections (1)
- sequence (1)
-
set
_ comment (1) -
set
_ current _ section (1) -
set
_ generator (1) -
set
_ passwd (1) -
set
_ visibility _ for (1) - setsockopt (1)
-
setup
_ rdoc (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) - shutdown (2)
-
single
_ delegate (1) - size (1)
- size= (1)
- standalone (1)
- standalone= (1)
- start (4)
-
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) - textinput (2)
- textinput= (2)
- title (7)
- title= (6)
- toplevel (1)
-
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) - url (1)
- url= (1)
- userdb (2)
- verbosity (1)
- verbosity= (1)
- version (1)
- version= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
検索結果
先頭5件
-
OpenSSL
:: SSL :: SocketForwarder # peeraddr -> Array (9004.0) -
ラップされているソケットの接続先相手の情報を返します。
ラップされているソケットの接続先相手の情報を返します。
IPSocket#peeraddr と同様です。 -
OpenSSL
:: SSL :: SocketForwarder # setsockopt(level , optname , optval) -> 0 (9004.0) -
ラップされているソケットのオプションを設定します。
ラップされているソケットのオプションを設定します。
BasicSocket#setsockopt と同様です。
@param level setsockopt(2) の level に相当する整数を指定します
@param optname setsockopt(2) の option_name に相当する整数を指定します
@param optval 設定される値を文字列で指定します。
@raise Errno::EXXX オプションの設定に失敗した場合発生します。 -
RDoc
:: CodeObject # comment -> String (9004.0) -
自身のコメントを返します。
自身のコメントを返します。 -
RDoc
:: CodeObject # comment=(comment) (9004.0) -
自身のコメントを comment に設定します。
自身のコメントを comment に設定します。
ただし、comment が空文字列だった場合は何もしません。
@param comment コメントを文字列で指定します。 -
RDoc
:: CodeObject # document _ children -> bool (9004.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。
@see RDoc::CodeObject#document_self -
RDoc
:: CodeObject # document _ children=(val) (9004.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを設定します。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
@param val true を指定した場合、上記をドキュメントに含めます。
@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules -
RDoc
:: CodeObject # document _ self -> bool (9004.0) -
自身をドキュメントに含めるかどうかを返します。
自身をドキュメントに含めるかどうかを返します。
@see RDoc::CodeObject#document_children -
RDoc
:: CodeObject # document _ self=(val) (9004.0) -
自身をドキュメントに含めるかどうかを設定します。
自身をドキュメントに含めるかどうかを設定します。
:doc: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
@param val true を指定した場合、自身をドキュメントに含めます。
@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc -
RDoc
:: CodeObject # documented? -> bool (9004.0) -
出力すべきドキュメントがあるかどうかを返します。
出力すべきドキュメントがあるかどうかを返します。 -
RDoc
:: CodeObject # metadata -> Hash (9004.0) -
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。 -
RDoc
:: CodeObject # parent=(val) (9004.0) -
自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。
自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。
@param val RDoc::CodeObject のサブクラスのオブジェクトを指定しま
す。 -
RDoc
:: CodeObject # parent _ file _ name -> String (9004.0) -
self.parent のファイル名を返します。
self.parent のファイル名を返します。
@see RDoc::CodeObject#parent -
RDoc
:: CodeObject # parent _ name -> String (9004.0) -
self.parent の名前を返します。
self.parent の名前を返します。
@see RDoc::CodeObject#parent -
RDoc
:: CodeObject # remove _ classes _ and _ modules -> () (9004.0) -
何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。
何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。 -
RDoc
:: CodeObject # remove _ methods _ etc -> () (9004.0) -
何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。
何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。 -
RDoc
:: CodeObject # section=(val) (9004.0) -
所属する section を設定します。
所属する section を設定します。
@param val RDoc::Context::Section オブジェクトを指定します。 -
RDoc
:: CodeObject # start _ doc -> () (9004.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 -> () (9004.0) -
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。
:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。
@see RDoc::CodeObject#start_doc -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (9004.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (9004.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。 -
RDoc
:: Context # add _ constant(const) -> () (9004.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。 -
RDoc
:: Context # add _ include(an _ include) -> () (9004.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。 -
RDoc
:: Context # add _ method(a _ method) -> () (9004.0) -
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。 -
RDoc
:: Context # add _ require(a _ require) -> () (9004.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。 -
RDoc
:: Context # add _ to(array , thing) -> () (9004.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... -
RDoc
:: Context # defined _ in?(file) (9004.0) -
Return true if at least part of this thing was defined in file
Return true if at least part of this thing was defined in file -
RDoc
:: Context # find _ local _ symbol(symbol) (9004.0) -
Finds a method, constant, attribute, module or files named +symbol+ in this context
Finds a method, constant, attribute, module or files named +symbol+ in
this context -
RDoc
:: Context # find _ symbol(symbol , method=nil) (9004.0) -
Look up the given symbol. If method is non-nil, then we assume the symbol references a module that contains that method
Look up the given symbol. If method is non-nil, then we assume
the symbol references a module that contains that method -
RDoc
:: Context # in _ files (9004.0) -
Files this context is found in
Files this context is found in -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (9004.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: Context # initialize _ methods _ etc -> () (9004.0) -
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。 -
RDoc
:: Context # name -> String (9004.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context # ongoing _ visibility=(vis) (9004.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # set _ current _ section(title , comment) -> () (9004.0) -
Handle sections
Handle sections -
RDoc
:: Context # set _ visibility _ for(methods , visibility , singleton = false) -> () (9004.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 # unmatched _ alias _ lists=(val) (9004.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。 -
RDoc
:: Context # visibility -> :public | :protected | :private (9004.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Context :: Section # ==(other) -> bool (9004.0) -
自身と other のシーケンス番号を比較した結果を返します。
自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。 -
RDoc
:: Context :: Section # comment -> String | nil (9004.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (9004.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # sequence -> String (9004.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Context :: Section # set _ comment(comment) -> () (9004.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Context :: Section # title -> String | nil (9004.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Generator :: Darkfish # generate -> () (9004.0) -
解析した情報を HTML ファイルや検索用のインデックスに出力します。
解析した情報を HTML ファイルや検索用のインデックスに出力します。 -
RDoc
:: Generator :: JsonIndex # generate -> () (9004.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。 -
RDoc
:: Generator :: RI # generate -> () (9004.0) -
解析した情報を ri コマンドから読めるようにファイルに出力します。
解析した情報を ri コマンドから読めるようにファイルに出力します。 -
RDoc
:: Markdown # break _ on _ newline -> bool (9004.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (9004.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: Markdown # css -> bool (9004.0) -
CSS を記述した場合に出力に含めるかどうかを返します。
CSS を記述した場合に出力に含めるかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # css=(val) (9004.0) -
CSS を記述した場合に出力に含めるかどうかを設定します。
CSS を記述した場合に出力に含めるかどうかを設定します。 -
RDoc
:: Markdown # definition _ lists -> bool (9004.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (9004.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # extension(name , enable) -> () (9004.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (9004.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markdown # github -> bool (9004.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し ます。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。
デフォルトでは true を返します。 -
RDoc
:: Markdown # github=(val) (9004.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定 します。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定
します。 -
RDoc
:: Markdown # html -> bool (9004.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # html=(val) (9004.0) -
HTML を記述した場合にそのまま出力するかどうかを設定します。
HTML を記述した場合にそのまま出力するかどうかを設定します。 -
RDoc
:: Markdown # notes -> bool (9004.0) -
脚注の出力を有効にするかどうかを返します。
脚注の出力を有効にするかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # notes=(val) (9004.0) -
脚注の出力を有効にするかどうかを設定します。
脚注の出力を有効にするかどうかを設定します。 -
RDoc
:: Markup # add _ html(tag , name) -> () (9004.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) -> () (9004.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 # content -> String (9004.0) -
変換する文字列を返します。
変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。
@see SM::SimpleMarkup#convert -
RDoc
:: Markup # convert(str , formatter) -> object | "" (9004.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Markup # get _ line _ types -> [Symbol] (9004.0) -
変換する文字列の各行のタイプを Symbol の配列で返します。
変換する文字列の各行のタイプを Symbol の配列で返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
@see SM::SimpleMarkup#convert -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (9004.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
:: Markup :: Formatter # convert(content) -> () (9004.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: Options # all _ one _ file -> bool (9004.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # charset -> String (9004.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # coverage _ report -> Integer | false (9004.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # coverage _ report=(val) (9004.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # css -> String (9004.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # diagram -> bool (9004.0) -
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。 -
RDoc
:: Options # dry _ run -> bool (9004.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # dry _ run=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding -> Encoding (9004.0) -
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。 -
RDoc
:: Options # encoding=(val) (9004.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude -> Regexp (9004.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (9004.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (9004.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (9004.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # fileboxes -> bool (9004.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # files -> [String] (9004.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # finish _ page _ dir (9004.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # force _ output -> bool (9004.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # force _ output=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # force _ update -> bool (9004.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (9004.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (9004.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator -> Generator (9004.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # generator=(val) (9004.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # hyperlink _ all -> bool (9004.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # hyperlink _ all=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # image _ format -> String (9004.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # include _ line _ numbers -> bool (9004.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (9004.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (9004.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # main _ page -> String | nil (9004.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # main _ page=(val) (9004.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。