280件ヒット
[1-100件を表示]
（0.019秒）
:![[x]](/images/drop-condition-icon.png "条件を削除"){kind=icon}
種類
- ライブラリ (120)
- 文書 (76)
- インスタンスメソッド (48)
- クラス (24)
- 特異メソッド (12)
ライブラリ
- ビルトイン (24)
-
rdoc
/ code _ object (12) -
rdoc
/ markup (24) -
rdoc
/ parser (12)
クラス
- Module (12)
-
RDoc
:: CodeObject (12) -
RDoc
:: Markup (12) -
RDoc
:: Parser (12)
オブジェクト
- main (12)
キーワード
- Markup (12)
-
NEWS for Ruby 2
. 1 . 0 (12) -
NEWS for Ruby 2
. 2 . 0 (11) -
NEWS for Ruby 2
. 5 . 0 (8) -
NEWS for Ruby 3
. 0 . 0 (5) -
NEWS for Ruby 3
. 1 . 0 (4) - Options (12)
- Ruby用語集 (12)
-
add
_ special (12) -
cgi
/ session (12) - drb (12)
- mkmf (12)
-
parse
_ files _ matching (12) -
rake
/ rdoctask (12) -
rdoc
/ generator (12) -
rdoc
/ generator / json _ index (12) -
rdoc
/ parser (12) -
rdoc
/ parser / ruby (12) - refine (12)
-
ruby 1
. 8 . 2 feature (12) -
ruby 1
. 8 . 4 feature (12) - rubygems (12)
-
start
_ doc (12) - using (12)
検索結果
-
rdoc (38428.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
...RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby......ットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。
=== ロードマップ
* RDoc で Ruby のソースファイルに対するドキュメ......ントも使え
ますし、=begin/=end でのコメントも使えます。=begin/=end を使う場合は、
以下のように =begin の行に 'rdoc' タグを付ける必要があります。
=begin rdoc
Documentation to
be processed by RDoc.
=end
パラグラフは左のインデン... -
rdoc
/ generator (6188.0) -
RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。
...RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。
RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属して......ネレータの登録
RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。
class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
=== rdoc のオプションの追加
rdoc ではオプションの処理の前に RDoc::Options は各ジェネ......る RDoc::Options#option_parser に対して rdoc コマンドのオプ
ションを追加できます。lib:rdoc/options#custom_options の例と
OptionParser も併せて参照してください。
=== ジェネレータのインストール
ソースコードを解析した後は RDoc:RDoc オ... -
rake
/ rdoctask (6090.0) -
ドキュメントを作成するためのタスクを定義します。
...す。
: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。
例:
Rake::RDocTask.new do......ain = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
end
例:
# RDoc タスクに別の名前を付ける例
Rake::RDocTask.new(:rdoc_dev) do |rd|
rd.main = "README.doc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
rd.options << "--all"
end... -
rdoc
/ parser (6088.0) -
rdoc で解析できるファイルの種類を追加するためのサブライブラリです。
...rdoc で解析できるファイルの種類を追加するためのサブライブラリです。
以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。
* #initialize(top_level, file_name, body, options, stats)
* #sc......* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
* options: RDoc::Options オブジェクトを指定します。
* stats: RDoc::Stats......きるファイル名のパ
ターンを登録しておく必要があります。
例:
require "rdoc/parser"
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
def initialize(file_name, body, options)
...
end
def scan
...
end
end... -
rdoc
/ generator / json _ index (6030.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するサブライブラリです。
...います。:
class RDoc::Generator::Darkfish
def initialize options
# ...
@base_dir = Pathname.pwd.expand_path
@json_index = RDoc::Generator::JsonIndex.new self, options
end
def generate
# ...
@json_index.generate
end
end
=== インデックス... -
rdoc
/ parser / ruby (6012.0) -
Ruby のソースコードを解析するためのサブライブラリです。
...めたい場合、## でコメントを開始します。
##
# This is a meta-programmed method!
add_my_method :meta_method, :arg1, :arg2
RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名と......キュメントに含める事ができます。
##
# :attr_writer: ghost_writer
# There is an attribute here, but you can't see it!
##
# :method: ghost_method
# There is a method here, but you can't see it!
##
# this is a comment for a regular method
def regular_method() end... -
RDoc
:: Options (3112.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックし......まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する......ns rdoc_options
op = rdoc_options.option_parser
op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dictionary アクセサの定義が必要
rdoc_options.spell_dictionary = dictionary
end
end
end... -
RDoc
:: Markup (3070.0) -
RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
...RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
例:
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
独自のフォーマットを行うようにパーサを拡張する事もできます。
例:
req......uire 'rdoc/markup'
require 'rdoc/markup/to_html'
class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end
m = RDoc::Markup.new
# { 〜 } までを :STRIK......STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")
puts "<body>#{wh.convert ARGF.read}</body>"
変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。... -
RDoc
:: CodeObject # start _ doc -> () (3040.0) -
以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。
...メントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。
:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。
@see RDoc::CodeObject#end_doc...